Create or extend annotation queue item lock

PUT/v1/private/annotation-queues/{queueId}/items/{itemId}/lockCreate or extend annotation queue item lock

Claim an annotation queue item for the current user, or extend an existing lock

Parameters

queueIdstring · uuidpathrequired

itemIdstring · uuidpathrequired

Responses

objectLockResponse

acquiredboolean

expires_atstring · date-time

item_idstring · uuid

locked_bystring

Example response

{
  "acquired": true,
  "expires_at": "2026-06-09T00:00:00Z",
  "item_id": "00000000-0000-0000-0000-000000000000",
  "locked_by": "string"
}

Examples

queueIdrequiredpath parameter

itemIdrequiredpath parameter

curl -X PUT 'http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000/lock'

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000/lock', { method: 'PUT' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000/lock', { method: 'PUT' });
console.log(await response.json());

import requests

response = requests.request("PUT", "http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000/lock")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "PUT", "http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000/lock", nil)
	if err != nil {
		panic(err)
	}
	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/00000000-0000-0000-0000-000000000000/lock");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
$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/00000000-0000-0000-0000-000000000000/lock"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .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/00000000-0000-0000-0000-000000000000/lock")
request = Net::HTTPGenericRequest.new("PUT", false, true, uri)
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.Put, "http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000/lock");
using var response = await client.SendAsync(request);

{
  "acquired": true,
  "expires_at": "2026-06-09T00:00:00Z",
  "item_id": "00000000-0000-0000-0000-000000000000",
  "locked_by": "string"
}