Skip to main content
PUT
Update task evaluators

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
evaluator_ids
string[]
required

The full ordered set of evaluators the task should end up linked to, in display order. Missing ones are unlinked, new ones are linked, and the order sets their position. Send an empty list to unlink all. Each must be one you created or a built-in default

Example:
optional_evaluator_ids
string[] | null

Which of evaluator_ids annotators may leave blank. Applied as a whole set, so an ID left out becomes required again. Optional evaluators do not hold a labelling job back from completing. Omit to leave every evaluator as it is

Example:

Response

Successful Response

message
string
required

Confirmation that the task's evaluators were updated

Example:

"Task evaluators updated"

evaluator_ids
string[]
required

The task's evaluator IDs after the update, in display order

linked
string[]
required

Evaluator IDs newly linked by this request

unlinked
string[]
required

Evaluator IDs unlinked by this request