For the complete documentation index, see llms.txt. This page is also available as Markdown.

Evaluations

List Production Eval Definitions

get
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
service_idstring · uuid · nullableOptional
activeboolean · nullableOptional
limitinteger · max: 100OptionalDefault: 10
continuation_tokenintegerOptionalDefault: 0
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokeninteger · nullableOptional
totalinteger · nullableOptional
get/v1/{workspace_id}/production-eval-definitions

Create Production Eval Definition

post
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Body
eval_keystring · min: 1 · max: 128Required
eval_typestring · enumRequiredPossible values:
service_idstring · uuid · nullableOptional
assertion_kindstring · max: 128 · nullableOptional
metric_keystring · max: 128 · nullableOptional
expectedanyOptional
activebooleanOptionalDefault: true
Responses
201

Successful Response

application/json

An eval (assertion or metric-eval) that runs against a workspace's live calls — the production analogue of a sim case's evals. service_id None applies to every service in the workspace. expected is JSON: a phrase string for assertions, or a {gte|lte|equals|...} threshold for metric-evals.

idstring · uuidOptional
workspace_idstring · uuidRequired
service_idstring · uuid · nullableOptional
eval_keystring · max: 128Required
eval_typestring · enumRequiredPossible values:
assertion_kindstring · max: 128 · nullableOptional
metric_keystring · max: 128 · nullableOptional
expectedanyOptional
activebooleanOptionalDefault: true
created_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
post/v1/{workspace_id}/production-eval-definitions

Get Production Eval Definition

get
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
definition_idstring · uuidRequired
Responses
200

Successful Response

application/json

An eval (assertion or metric-eval) that runs against a workspace's live calls — the production analogue of a sim case's evals. service_id None applies to every service in the workspace. expected is JSON: a phrase string for assertions, or a {gte|lte|equals|...} threshold for metric-evals.

idstring · uuidOptional
workspace_idstring · uuidRequired
service_idstring · uuid · nullableOptional
eval_keystring · max: 128Required
eval_typestring · enumRequiredPossible values:
assertion_kindstring · max: 128 · nullableOptional
metric_keystring · max: 128 · nullableOptional
expectedanyOptional
activebooleanOptionalDefault: true
created_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
get/v1/{workspace_id}/production-eval-definitions/{definition_id}

Delete Production Eval Definition

delete
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
definition_idstring · uuidRequired
Responses
204

Successful Response

No content

delete/v1/{workspace_id}/production-eval-definitions/{definition_id}

No content

Update Production Eval Definition

patch
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
definition_idstring · uuidRequired
Body
service_idstring · uuid · nullableOptional
eval_keystring · min: 1 · max: 128 · nullableOptional
eval_typestring · enum · nullableOptionalPossible values:
assertion_kindstring · max: 128 · nullableOptional
metric_keystring · max: 128 · nullableOptional
expectedanyOptional
activeboolean · nullableOptional
Responses
200

Successful Response

application/json

An eval (assertion or metric-eval) that runs against a workspace's live calls — the production analogue of a sim case's evals. service_id None applies to every service in the workspace. expected is JSON: a phrase string for assertions, or a {gte|lte|equals|...} threshold for metric-evals.

idstring · uuidOptional
workspace_idstring · uuidRequired
service_idstring · uuid · nullableOptional
eval_keystring · max: 128Required
eval_typestring · enumRequiredPossible values:
assertion_kindstring · max: 128 · nullableOptional
metric_keystring · max: 128 · nullableOptional
expectedanyOptional
activebooleanOptionalDefault: true
created_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
patch/v1/{workspace_id}/production-eval-definitions/{definition_id}

Evaluate Call

post

Run the workspace's active eval definitions against one completed call and persist the verdicts. Synchronous (the caller waits on the judge); the eager post-call trigger is a separate change.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
conversation_idstring · uuidRequired
Responses
200

Successful Response

application/json
conversation_idstring · uuidRequired
post/v1/{workspace_id}/calls/{conversation_id}/evaluate

Get Call Eval Results

get
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
conversation_idstring · uuidRequired
Responses
200

Successful Response

application/json
conversation_idstring · uuidRequired
get/v1/{workspace_id}/calls/{conversation_id}/eval-results

Last updated

Was this helpful?