Create annotation queue batch | Opik Documentation

POST/v1/private/annotation-queues/batchCreate annotation queue batch

Create multiple annotation queues for human annotation workflows

Request body

application/json

objectAnnotationQueueBatch_Write

Batch of annotation queues to create

annotation_queuesarray of objectrequired

List of annotation queues to create

maxItems 1000 · minItems 1 · uniqueItems true

Show child attributes

maxItems 1000 · minItems 1 · uniqueItems true

Show array items

List of annotation queues to create

annotators_per_iteminteger · int32

maximum 1000 · minimum 1

automationobject

Show child attributes

conditionsobject

Show child attributes

groupsarray of objectrequired

maxItems 5 · minItems 0

Show child attributes

maxItems 5 · minItems 0

Show array items

conditionsarray of objectrequired

maxItems 5 · minItems 0

Show child attributes

maxItems 5 · minItems 0

Show array items

operatorstringrequired

one of ">", "<", "="

score_namestringrequired

maxLength 255 · minLength 0

valuenumber · doublerequired

enabledboolean

max_items_in_queueinteger · int32

comments_enabledboolean

descriptionstring

feedback_definition_namesarray of string

Show child attributes

idstring · uuid

instructionsstring

lock_timeout_secondsinteger · int32

maximum 3600 · minimum 1

namestringrequired

minLength 1

project_idstring · uuidrequired

scopestringrequired

one of "trace", "thread"

Example request

{
  "annotation_queues": [
    {
      "annotators_per_item": 0,
      "automation": {
        "conditions": {
          "groups": [
            {
              "conditions": [
                {
                  "operator": "<",
                  "score_name": "string",
                  "value": 0
                }
              ]
            }
          ]
        },
        "enabled": true,
        "max_items_in_queue": 0
      },
      "comments_enabled": true,
      "description": "string",
      "feedback_definition_names": [
        "string"
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "instructions": "string",
      "lock_timeout_seconds": 0,
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "scope": "thread"
    }
  ]
}

Responses

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/annotation-queues/batch' \
  -H 'Content-Type: application/json' \
  -d '{"annotation_queues":[{"annotators_per_item":0,"automation":{"conditions":{"groups":[{"conditions":[{"operator":"<","score_name":"string","value":0}]}]},"enabled":true,"max_items_in_queue":0},"comments_enabled":true,"description":"string","feedback_definition_names":["string"],"id":"00000000-0000-0000-0000-000000000000","instructions":"string","lock_timeout_seconds":0,"name":"string","project_id":"00000000-0000-0000-0000-000000000000","scope":"thread"}]}'

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues/batch', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"annotation_queues":[{"annotators_per_item":0,"automation":{"conditions":{"groups":[{"conditions":[{"operator":"<","score_name":"string","value":0}]}]},"enabled":true,"max_items_in_queue":0},"comments_enabled":true,"description":"string","feedback_definition_names":["string"],"id":"00000000-0000-0000-0000-000000000000","instructions":"string","lock_timeout_seconds":0,"name":"string","project_id":"00000000-0000-0000-0000-000000000000","scope":"thread"}]}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues/batch', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"annotation_queues\":[{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"id\":\"00000000-0000-0000-0000-000000000000\",\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"scope\":\"thread\"}]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/annotation-queues/batch",
    headers={"Content-Type": "application/json"},
    data='{"annotation_queues":[{"annotators_per_item":0,"automation":{"conditions":{"groups":[{"conditions":[{"operator":"<","score_name":"string","value":0}]}]},"enabled":true,"max_items_in_queue":0},"comments_enabled":true,"description":"string","feedback_definition_names":["string"],"id":"00000000-0000-0000-0000-000000000000","instructions":"string","lock_timeout_seconds":0,"name":"string","project_id":"00000000-0000-0000-0000-000000000000","scope":"thread"}]}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"annotation_queues":[{"annotators_per_item":0,"automation":{"conditions":{"groups":[{"conditions":[{"operator":"<","score_name":"string","value":0}]}]},"enabled":true,"max_items_in_queue":0},"comments_enabled":true,"description":"string","feedback_definition_names":["string"],"id":"00000000-0000-0000-0000-000000000000","instructions":"string","lock_timeout_seconds":0,"name":"string","project_id":"00000000-0000-0000-0000-000000000000","scope":"thread"}]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/annotation-queues/batch", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/annotation-queues/batch");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"annotation_queues\":[{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"id\":\"00000000-0000-0000-0000-000000000000\",\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"scope\":\"thread\"}]}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/annotation-queues/batch"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"annotation_queues\":[{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"id\":\"00000000-0000-0000-0000-000000000000\",\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"scope\":\"thread\"}]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/annotation-queues/batch")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"annotation_queues\":[{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"id\":\"00000000-0000-0000-0000-000000000000\",\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"scope\":\"thread\"}]}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/annotation-queues/batch");
request.Content = new StringContent("{\"annotation_queues\":[{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"id\":\"00000000-0000-0000-0000-000000000000\",\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"scope\":\"thread\"}]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}