Annotation Queues Query Stream

Query annotation queues for a project (streaming NDJSON response).

POST /annotation_queues/query

Annotation Queues Query Stream

cURL

curl --request POST \
  --url https://api.example.com/annotation_queues/query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "name": "Error",
  "sort_by": [
    {
      "field": "<string>"
    }
  ],
  "limit": 10,
  "offset": 0
}
'

import requests

url = "https://api.example.com/annotation_queues/query"

payload = {
    "project_id": "<string>",
    "name": "Error",
    "sort_by": [{ "field": "<string>" }],
    "limit": 10,
    "offset": 0
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    name: 'Error',
    sort_by: [{field: '<string>'}],
    limit: 10,
    offset: 0
  })
};

fetch('https://api.example.com/annotation_queues/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/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>',
    'name' => 'Error',
    'sort_by' => [
        [
                'field' => '<string>'
        ]
    ],
    'limit' => 10,
    'offset' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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/query"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"name\": \"Error\",\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"limit\": 10,\n  \"offset\": 0\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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/query")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"name\": \"Error\",\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"limit\": 10,\n  \"offset\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/annotation_queues/query")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"name\": \"Error\",\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"limit\": 10,\n  \"offset\": 0\n}"

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

422

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

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request to query annotation queues for a project.

project_id · string · required

Example:

"entity/project"

name · string | null

Filter by queue name (case-insensitive partial match)

Example:

"Error"

sort_by · SortBy · object[] | null

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

Show child attributes

limit · integer | null

Example:

10

offset · integer | null

Example:

0

Response

200

application/json

Successful Response