Update Queue

Update an existing annotation queue's configuration.

Update Queue

Update an annotation queue’s name, description, instructions, and other settings.

PUT https://api.futureagi.com/model-hub/annotation-queues/{id}/
Bearer 
          Click "Try It" to send a request

Authentication

HeaderDescription
X-Api-KeyYour API key
X-Secret-KeyYour secret key

Path Parameters

ParameterTypeRequiredDescription
idUUIDYesThe annotation queue ID

Request Body

All fields from the create endpoint are accepted. Only provided fields are updated.

FieldTypeDescription
namestringQueue name
descriptionstringQueue description
instructionsstringInstructions for annotators
assignment_strategystringmanual, round_robin, or load_balanced
annotations_requiredintegerAnnotations required per item
reservation_timeout_minutesintegerReservation timeout in minutes
requires_reviewbooleanWhether review is required
label_idsarrayLabel UUIDs to attach
annotator_idsarrayAnnotator user UUIDs

Response

Returns the updated queue object.

Code Examples

import requests

queue_id = "your-queue-uuid"
resp = requests.put(
    f"https://api.futureagi.com/model-hub/annotation-queues/{queue_id}/",
    headers={"X-Api-Key": "YOUR_KEY", "X-Secret-Key": "YOUR_SECRET"},
    json={"name": "Updated Queue", "annotations_required": 3}
)
print(resp.json())
import axios from 'axios';

const queueId = 'your-queue-uuid';
const resp = await axios.put(
  `https://api.futureagi.com/model-hub/annotation-queues/${queueId}/`,
  { name: 'Updated Queue', annotationsRequired: 3 },
  { headers: { 'X-Api-Key': 'YOUR_KEY', 'X-Secret-Key': 'YOUR_SECRET' } }
);
console.log(resp.data);
curl -X PUT "https://api.futureagi.com/model-hub/annotation-queues/your-queue-uuid/" \
  -H "X-Api-Key: YOUR_KEY" \
  -H "X-Secret-Key: YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Queue", "annotations_required": 3}'
Was this page helpful?

Questions & Discussion