Skip to main content
POST
Run evaluators on items

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

task_uuid
string
required

Annotation task to act on

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Body

application/json
evaluators
EvaluatorRunRequestEntry · object[]
required

The evaluators to run. Each must be linked to the task

item_ids
string[]

Item IDs to run on. Required when select_all=false. Ignored when select_all=true

select_all
boolean
default:false

When true, run on every item in the task. Set q to run only items whose name matches it

q
string | null

Case-insensitive substring filter on payload.name. Applies only when select_all=true

Response

Successful Response

job_uuid
string
required

ID of the evaluator-run job. Poll it for status and results

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

status
enum<string>
required

Status of the job right after you launch it

Available options:
queued,
in_progress
evaluator_count
integer
required

How many evaluators the job will run

item_count
integer
required

How many items the job will run on