Skip to main content
POST
Evaluate

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

Successful response

evaluation
object
required