curl --request POST \
--url https://api.calibrate.artpark.ai/annotation-tasks/{task_uuid}/jobs \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"annotator_ids": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
]
}
'import requests
url = "https://api.calibrate.artpark.ai/annotation-tasks/{task_uuid}/jobs"
payload = { "annotator_ids": ["f47ac10b-58cc-4372-a567-0e02b2c3d479"] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"jobs": [
{
"uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"public_token": "kO3n1xPq7sVbYcT2mA9eR4wZ1jD5hL8f",
"annotator_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"annotator_name": "<string>",
"item_ids": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
],
"item_count": 123,
"evaluator_ids": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
],
"status": "pending"
}
],
"count": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Create labelling jobs
Assign items to annotators, creating one labelling job per annotator
curl --request POST \
--url https://api.calibrate.artpark.ai/annotation-tasks/{task_uuid}/jobs \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"annotator_ids": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
]
}
'import requests
url = "https://api.calibrate.artpark.ai/annotation-tasks/{task_uuid}/jobs"
payload = { "annotator_ids": ["f47ac10b-58cc-4372-a567-0e02b2c3d479"] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"jobs": [
{
"uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"public_token": "kO3n1xPq7sVbYcT2mA9eR4wZ1jD5hL8f",
"annotator_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"annotator_name": "<string>",
"item_ids": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
],
"item_count": 123,
"evaluator_ids": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
],
"status": "pending"
}
],
"count": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API key for authentication
Path Parameters
Annotation task to act on
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Body
Annotator IDs to assign, creating one labelling job for each annotator. Must be in your workspace
["f47ac10b-58cc-4372-a567-0e02b2c3d479"]
Item IDs to assign. Required when select_all=false. Ignored when select_all=true
When true, assign every item in the task and ignore item_ids. Set q to assign only items whose name matches it
Case-insensitive substring filter on payload.name. Applies only when select_all=true
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
["f47ac10b-58cc-4372-a567-0e02b2c3d479"]
When true, the labelling form lets the annotator leave a comment on each item
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
optional, required, hidden