Annotation queues
Skip a reserved item
Closes the item without scores (the reviewer holding a live reservation).
POST
/
v1
/
annotation-queues
/
{id_or_name}
/
items
/
{item_id}
/
skip
Skip a reserved item
curl --request POST \
--url https://api.veri.studio/v1/annotation-queues/{id_or_name}/items/{item_id}/skip \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "<string>"
}
'import requests
url = "https://api.veri.studio/v1/annotation-queues/{id_or_name}/items/{item_id}/skip"
payload = { "note": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '<string>'})
};
fetch('https://api.veri.studio/v1/annotation-queues/{id_or_name}/items/{item_id}/skip', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"object": "<string>",
"id": "<string>",
"queue_id": "<string>",
"target_type": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"request_id": "<string>",
"deployment_id": "<string>",
"thread_id": "<string>",
"target_revision": "<string>",
"experiment_id": "<string>",
"item_id": "<string>",
"reserved_by": "<string>",
"reserved_until": "2023-11-07T05:31:56Z",
"completed_by": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"correction": "<unknown>",
"note": "<string>"
}Authorizations
API key with the vk_ prefix. Create one from the dashboard.
Path Parameters
Queue id (aq_...) or name
Item id (ai_...)
Body
application/json
Why the item was skipped (at most 8 KB).
Response
The skipped item
Always "annotation_item".
ai_...
trace | thread | experiment_item
pending | reserved | completed | skipped. An expired reservation is pending.
Trace items: the request (trace id veri-<request_id>).
Trace and thread items.
Thread items: the thread and the last request under review.
Experiment-item items.
While reserved: who holds it and until when.
Who closed the item (completed or skipped) and when.
The reviewer's corrected answer (any JSON value).
Skip a reserved item
curl --request POST \
--url https://api.veri.studio/v1/annotation-queues/{id_or_name}/items/{item_id}/skip \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "<string>"
}
'import requests
url = "https://api.veri.studio/v1/annotation-queues/{id_or_name}/items/{item_id}/skip"
payload = { "note": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '<string>'})
};
fetch('https://api.veri.studio/v1/annotation-queues/{id_or_name}/items/{item_id}/skip', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"object": "<string>",
"id": "<string>",
"queue_id": "<string>",
"target_type": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"request_id": "<string>",
"deployment_id": "<string>",
"thread_id": "<string>",
"target_revision": "<string>",
"experiment_id": "<string>",
"item_id": "<string>",
"reserved_by": "<string>",
"reserved_until": "2023-11-07T05:31:56Z",
"completed_by": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"correction": "<unknown>",
"note": "<string>"
}