Update Queue Status

Transition an annotation queue to a new status.

Update Queue Status

Transition a queue’s status. Only valid transitions are allowed.

POST https://api.futureagi.com/model-hub/annotation-queues/{id}/update-status/
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

FieldTypeRequiredDescription
statusstringYesTarget status: draft, active, paused, or completed

Note

Only valid status transitions are permitted. For example: draft to active, active to paused, paused to active, active to completed. Invalid transitions return a 400 error.

Response

Returns the updated queue object with the new status.

Code Examples

import requests

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

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

Questions & Discussion