Detect Issues

Run issue detection on a conversation provided in the request body.

Send an array of messages in OpenAI chat format. By default, the endpoint evaluates the last message. Set message_indexes_to_evaluate to evaluate a different message or multiple messages.

Set store_conversation to true to persist the conversation, messages, and evaluation in the database so they appear in the dashboard.

You can override the active workspace evaluator by providing either evaluator_id or a config object with custom labels and domain context.

Header Parameters

x-workspace-id?|

Workspace UUID for session-authenticated calls.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

messages*array<|||||>

Array of messages in OpenAI chat format. By default, the last message is evaluated; set message_indexes_to_evaluate to evaluate a different message or multiple messages.

Items1 <= items

store_conversation?boolean

Persist conversation, messages, and evaluation in the database.

Defaulttrue

generation_info?|

Metadata about the LLM call that produced the assistant message.

config?|

Override the workspace issue config for this request.

evaluator_id?|

Workspace evaluator ID to use for labels and domain context.

message_indexes_to_evaluate?array<>|

Zero-based indexes of messages that may receive issue annotations. Defaults to the last message.

Response Body

`application/json`

curl -X POST "https://loading/v1/evaluate" \  -H "Content-Type: application/json" \  -d '{    "messages": [      {        "content": "string",        "role": "developer"      }    ]  }'

{
  "annotations": [
    {
      "message_index": 0,
      "text": "string",
      "label": "string",
      "explanation": "string",
      "message_part_index": 0,
      "start_offset": 0,
      "end_offset": 0,
      "tool_name": "string",
      "parameter_name": "string"
    }
  ],
  "usage": {
    "input_tokens": 0,
    "cost_cents": 0
  },
  "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",
  "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Detect Issues

Header Parameters

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`