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
sort_bystring[]OptionalDefault: []
limitinteger · max: 200OptionalDefault: 50
continuation_tokenanyOptional
service_idstring · uuid · nullableOptional
activeboolean · nullableOptional
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokenanyOptional
get/v1/{workspace_id}/production-eval-definitions
GET /v1/{workspace_id}/production-eval-definitions HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "service_id": "123e4567-e89b-12d3-a456-426614174000",
      "eval_key": "text",
      "eval_type": "assertion",
      "assertion_kind": "text",
      "metric_key": "text",
      "expected": null,
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "active": true,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Create Production Eval Definition

post

Create a production eval definition.

metric_key must name an active ai_query metric on call_intelligence in this workspace's metric settings; any other key returns 422.

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
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
POST /v1/{workspace_id}/production-eval-definitions HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "eval_key": "text",
  "eval_type": "metric",
  "service_id": "123e4567-e89b-12d3-a456-426614174000",
  "metric_key": "text",
  "expected": null,
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "active": true
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "service_id": "123e4567-e89b-12d3-a456-426614174000",
  "eval_key": "text",
  "eval_type": "assertion",
  "assertion_kind": "text",
  "metric_key": "text",
  "expected": null,
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "active": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

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}
DELETE /v1/{workspace_id}/production-eval-definitions/{definition_id} HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Production Eval Definition

patch

Update a production eval definition.

A patch that sets metric_key or eval_type, or sets active to true, re-checks the metric: a metric eval must name an active ai_query metric on call_intelligence, else 422. Clearing metric_key on a metric eval also returns 422. Any other patch, including active: false, leaves the stored key alone.

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}
PATCH /v1/{workspace_id}/production-eval-definitions/{definition_id} HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "service_id": "123e4567-e89b-12d3-a456-426614174000",
  "eval_key": "text",
  "eval_type": "assertion",
  "assertion_kind": "text",
  "metric_key": "text",
  "expected": null,
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "active": true
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "service_id": "123e4567-e89b-12d3-a456-426614174000",
  "eval_key": "text",
  "eval_type": "assertion",
  "assertion_kind": "text",
  "metric_key": "text",
  "expected": null,
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "active": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

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
POST /v1/{workspace_id}/calls/{conversation_id}/evaluate HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "conversation_id": "123e4567-e89b-12d3-a456-426614174000",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "service_id": "123e4567-e89b-12d3-a456-426614174000",
      "conversation_id": "123e4567-e89b-12d3-a456-426614174000",
      "call_sid": "text",
      "eval_key": "text",
      "eval_type": "assertion",
      "assertion_kind": "text",
      "metric_key": "text",
      "status": "passed",
      "passed": true,
      "score": 1,
      "expected": null,
      "actual": null,
      "rationale": "text",
      "justification": "text",
      "cited_turns": [],
      "computed_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Get Call Eval Results

get

A call's verdicts. Empty when the call exists but hasn't been evaluated; 404 when it doesn't exist.

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
GET /v1/{workspace_id}/calls/{conversation_id}/eval-results HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "conversation_id": "123e4567-e89b-12d3-a456-426614174000",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "service_id": "123e4567-e89b-12d3-a456-426614174000",
      "conversation_id": "123e4567-e89b-12d3-a456-426614174000",
      "call_sid": "text",
      "eval_key": "text",
      "eval_type": "assertion",
      "assertion_kind": "text",
      "metric_key": "text",
      "status": "passed",
      "passed": true,
      "score": 1,
      "expected": null,
      "actual": null,
      "rationale": "text",
      "justification": "text",
      "cited_turns": [],
      "computed_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Last updated

Was this helpful?