Annotation Queue Add Calls

Add calls to an annotation queue.

POST /annotation_queues/{queue_id}/items

Annotation Queue Add Calls

cURL

curl --request POST \
  --url https://api.example.com/annotation_queues/{queue_id}/items \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "call_ids": [
    "<string>"
  ],
  "display_fields": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "project_id": "<string>",
    "call_ids": ["<string>"],
    "display_fields": ["<string>"]
}
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>', call_ids: ['<string>'], display_fields: ['<string>']})
};

fetch('https://api.example.com/annotation_queues/{queue_id}/items', 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",
  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>',
    'call_ids' => [
        '<string>'
    ],
    'display_fields' => [
        '<string>'
    ]
  ]),
  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/{queue_id}/items"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"call_ids\": [\n    \"<string>\"\n  ],\n  \"display_fields\": [\n    \"<string>\"\n  ]\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/{queue_id}/items")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"call_ids\": [\n    \"<string>\"\n  ],\n  \"display_fields\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"call_ids\": [\n    \"<string>\"\n  ],\n  \"display_fields\": [\n    \"<string>\"\n  ]\n}"

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

200

{
  "added_count": 123,
  "duplicates": 123
}

{
  "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.

Path Parameters

queue_id · string · required

Body

application/json

Request body for adding calls to an annotation queue (queue_id comes from path).

project_id · string · required

Example:

"entity/project"

call_ids · string[] · required

Example:

["call-1", "call-2", "call-3"]

display_fields · string[] · required

JSON paths to display to annotators

Example:

["input.prompt", "output.text"]

Response

200

application/json

Successful Response

Response from adding calls to a queue.

added_count · integer · required

duplicates · integer · required