Skip to main content
POST
Evaluate

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Body schema for the evaluator evaluate endpoint. Provide either messageUuid or output as the thing to grade.

rubric
string
required

Natural-language criteria describing what a good output looks like.

Minimum string length: 1
messageUuid
string<uuid>

When set, the output to grade is read from this message's text.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
output
string

Text to grade directly. Used when messageUuid is not provided.

context
string

Optional extra context to ground the evaluation.

Response

Evaluate

evaluation
object
required