API ReferenceEvaluations

Create Evaluation

View as Markdown
Runs an evaluation on the provided content using the specified evaluator

Authentication

x-api-keystring
API key for authentication
OR
AuthorizationBearer
Bearer token authentication

Path parameters

idstringRequired
The ID or key of the evaluator

Request

This endpoint expects an object.
contentstring or list of strings or objectsRequired
Text to evaluate, an array of strings, or chat messages.
frequency_penaltydouble or nullOptional
confidence_thresholddouble or nullOptional
modelstring or nullOptional1-100 characters
presence_penaltydouble or nullOptional
reasoning_effortenum or nullOptional
verbosityenum or nullOptional
temperaturedouble or nullOptional
top_pdouble or nullOptional
variablesmap from strings to strings or nullOptional

Flat string key/value pairs substituted into {key} placeholders in the evaluator prompt. Reserved keys (options, option_descriptions, criteria) cannot be overridden. Not persisted; omitted from the response.

Response

Evaluation result
resultobjectOptional

Errors

403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error
503
Service Unavailable Error