Annotation Queue Items Query

Query items in an annotation queue with pagination and sorting.

POST /annotation_queues/{queue_id}/items/query

Annotation Queue Items Query

cURL

curl --request POST \
  --url https://api.example.com/annotation_queues/{queue_id}/items/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "filter": {
    "id": "<string>",
    "call_id": "<string>",
    "call_op_name": "<string>",
    "call_trace_id": "<string>",
    "added_by": "<string>",
    "annotation_states": [
      "unstarted",
      "in_progress"
    ]
  },
  "sort_by": [
    {
      "field": "<string>"
    }
  ],
  "limit": 50,
  "offset": 0,
  "include_position": false
}
'

import requests

url = "https://api.example.com/annotation_queues/{queue_id}/items/query"

payload = {
    "project_id": "<string>",
    "filter": {
        "id": "<string>",
        "call_id": "<string>",
        "call_op_name": "<string>",
        "call_trace_id": "<string>",
        "added_by": "<string>",
        "annotation_states": ["unstarted", "in_progress"]
    },
    "sort_by": [{ "field": "<string>" }],
    "limit": 50,
    "offset": 0,
    "include_position": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    filter: {
      id: '<string>',
      call_id: '<string>',
      call_op_name: '<string>',
      call_trace_id: '<string>',
      added_by: '<string>',
      annotation_states: ['unstarted', 'in_progress']
    },
    sort_by: [{field: '<string>'}],
    limit: 50,
    offset: 0,
    include_position: false
  })
};

fetch('https://api.example.com/annotation_queues/{queue_id}/items/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/annotation_queues/{queue_id}/items/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'project_id' => '<string>',
    'filter' => [
        'id' => '<string>',
        'call_id' => '<string>',
        'call_op_name' => '<string>',
        'call_trace_id' => '<string>',
        'added_by' => '<string>',
        'annotation_states' => [
                'unstarted',
                'in_progress'
        ]
    ],
    'sort_by' => [
        [
                'field' => '<string>'
        ]
    ],
    'limit' => 50,
    'offset' => 0,
    'include_position' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/annotation_queues/{queue_id}/items/query"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"filter\": {\n    \"id\": \"<string>\",\n    \"call_id\": \"<string>\",\n    \"call_op_name\": \"<string>\",\n    \"call_trace_id\": \"<string>\",\n    \"added_by\": \"<string>\",\n    \"annotation_states\": [\n      \"unstarted\",\n      \"in_progress\"\n    ]\n  },\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"limit\": 50,\n  \"offset\": 0,\n  \"include_position\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/annotation_queues/{queue_id}/items/query")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"filter\": {\n    \"id\": \"<string>\",\n    \"call_id\": \"<string>\",\n    \"call_op_name\": \"<string>\",\n    \"call_trace_id\": \"<string>\",\n    \"added_by\": \"<string>\",\n    \"annotation_states\": [\n      \"unstarted\",\n      \"in_progress\"\n    ]\n  },\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"limit\": 50,\n  \"offset\": 0,\n  \"include_position\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/annotation_queues/{queue_id}/items/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"filter\": {\n    \"id\": \"<string>\",\n    \"call_id\": \"<string>\",\n    \"call_op_name\": \"<string>\",\n    \"call_trace_id\": \"<string>\",\n    \"added_by\": \"<string>\",\n    \"annotation_states\": [\n      \"unstarted\",\n      \"in_progress\"\n    ]\n  },\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"limit\": 50,\n  \"offset\": 0,\n  \"include_position\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "id": "<string>",
      "project_id": "<string>",
      "queue_id": "<string>",
      "call_id": "<string>",
      "call_started_at": "2023-11-07T05:31:56Z",
      "call_op_name": "<string>",
      "call_trace_id": "<string>",
      "display_fields": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "call_ended_at": "2023-11-07T05:31:56Z",
      "added_by": "<string>",
      "annotator_user_id": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "position_in_queue": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

queue_id · string · required

Body

application/json

Request body for querying items in an annotation queue (queue_id comes from path).

project_id · string · required

Example:

"entity/project"

filter · AnnotationQueueItemsFilter · object | null

Filter queue items by call metadata and annotation state

Show child attributes

sort_by · SortBy · object[] | null

Sort by multiple fields (e.g., created_at, updated_at)

Show child attributes

limit · integer | null

Example:

50

offset · integer | null

Example:

0

include_position · boolean · default: false

Include position_in_queue field (1-based index in full queue)

Response

200

application/json

Successful Response

Response from querying annotation queue items.

items · AnnotationQueueItemSchema · object[] · required

Show child attributes