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

Evaluator Outcomes API

Write evaluator outcomes computed outside the platform onto your chats, so external quality signals appear alongside built-in evaluator results.

Evaluators normally analyze conversations inside the platform. Sometimes, though, the evaluation happens somewhere else: a scoring model in your data stack, a human review process, or business logic running in one of your workflows. The Evaluator Outcomes API lets you attach those externally computed outcomes to a chat. Outcomes are validated against the evaluators configured in your Workspace and appear in the platform like any other evaluator result.

Endpoint

POST https://platform.indigo.ai/rest/evaluator_outcome/{project_id}

{project_id} is your Workspace's numeric identifier — the same value exposed by the $project_id system variable.

Authentication

Authentication is handled via a Personal Access Token (PAT). Pass it in the Authorization header of every request:

Authorization: Bearer pat-*your_pat_value*

The token must belong to the same workspace identified by {project_id} in the path; otherwise the platform returns 403 Unauthorized.

Request Body

Field
Type
Required
Description

name

string

Label of an evaluator that exists and is active in your Workspace.

value

mixed

The outcome, matching the evaluator's type: a score (110), a boolean, or a label.

chat_id

integer

The chat the outcome refers to. Inside a flow, use the $chat_id system variable; stringified values such as "\{{$chat_id\}}" are accepted.

reasoning

string

Free-text explanation stored together with the outcome.

force

boolean

Set to true to overwrite an outcome that already exists for this evaluator on this chat. Defaults to false.

Outcomes can be written for Label, 1–10, and Boolean evaluators. Guardrails cannot receive outcomes through this API.

Example

Successful response:

Error Responses

Status
When

403

Missing or invalid PAT, or PAT not matching {project_id}.

404

No active evaluator with that label, or chat_id not found in this Workspace.

409

An outcome for this evaluator already exists on the chat — repeat the call with "force": true to overwrite it.

422

Invalid parameters, a value that doesn't match the evaluator's type, or an ambiguous evaluator label (two evaluators share the same label).

Typical Uses

  • Close the loop from a workflow — call the endpoint from an API Block at the end of a flow, passing $chat_id, to record a business outcome (e.g., order completed) as an evaluator result.

  • External quality pipelines — score conversations with your own models or human reviewers, then push the verdicts back so they live next to the platform's built-in evaluations.

See Evaluators and Guardrails for how evaluators are configured and where their results appear.

Last updated

Was this helpful?