Search annotation queue items | Opik Documentation

POST/v1/private/annotation-queues/{id}/items/searchSearch annotation queue items

Returns queue membership metadata — how each item got into the queue — for the given item ids. A lookup rather than a listing: the caller renders the items table from the traces or threads API with its own sort and filters, so it asks for exactly the ids it is displaying. Ids that are not in the queue are omitted.

Parameters

idstring · uuidpathrequired

Request body

application/json

objectAnnotationQueueItemIds_Public

idsarray of string · uuidrequired

maxItems 1000 · minItems 1 · uniqueItems true

Show child attributes

maxItems 1000 · minItems 1 · uniqueItems true

Example request

{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Responses

objectAnnotationQueueItems_Public

contentarray of object

Show child attributes

Show array items

idstring · uuid

sourcestring

one of "manual", "automated"

Example response

{
  "content": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "source": "automated"
    }
  ]
}

objectErrorMessage_Public

codeinteger · int32

detailsstring

messagestring

Example response

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

Examples

idrequiredpath parameter

curl -X POST 'http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/search' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["00000000-0000-0000-0000-000000000000"]}'

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/search', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"ids":["00000000-0000-0000-0000-000000000000"]}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/search', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"ids\":[\"00000000-0000-0000-0000-000000000000\"]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/search",
    headers={"Content-Type": "application/json"},
    data='{"ids":["00000000-0000-0000-0000-000000000000"]}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"ids":["00000000-0000-0000-0000-000000000000"]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/search", 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/00000000-0000-0000-0000-000000000000/items/search");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"ids\":[\"00000000-0000-0000-0000-000000000000\"]}");
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/00000000-0000-0000-0000-000000000000/items/search"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"ids\":[\"00000000-0000-0000-0000-000000000000\"]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/search")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"ids\":[\"00000000-0000-0000-0000-000000000000\"]}"
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/00000000-0000-0000-0000-000000000000/items/search");
request.Content = new StringContent("{\"ids\":[\"00000000-0000-0000-0000-000000000000\"]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "content": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "source": "automated"
    }
  ]
}

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