Skip to main content
POST
Create labelling jobs

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

Annotator IDs to assign, creating one labelling job for each annotator. Must be in your workspace

Example:
item_ids
string[]

Item IDs to assign. Required when select_all=false. Ignored when select_all=true

select_all
boolean
default:false

When true, assign every item in the task and ignore item_ids. Set q to assign only items whose name matches it

q
string | null

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

evaluator_ids
string[] | null

Subset of the task's linked evaluators to show in these jobs. Must be a subset of the current links, an empty list gives a 400. Applies to every annotator's job. Omit (None) to snapshot every linked evaluator

Example:
comments_enabled
boolean
default:true

When true, the labelling form lets the annotator leave a comment on each item

reasoning_mode
enum<string>
default:optional

How the labelling form treats the reasoning box on each judgement. optional shows it, required shows it and asks the annotator to fill it in, hidden leaves it out

Available options:
optional,
required,
hidden

Response

Successful Response

jobs
LabellingJobCreated · object[]
required

The jobs created, one for each annotator

count
integer
required

How many jobs were created