Submit Annotations

Submit annotations and notes for a queue item.

Submit Annotations

Submit one or more annotations (label-value pairs) and optional notes for a specific queue item.

POST https://api.futureagi.com/model-hub/annotation-queues/{queue_id}/items/{item_id}/annotations/submit/
Bearer 
          Click "Try It" to send a request

Authentication

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

Path Parameters

ParameterTypeRequiredDescription
queue_idUUIDYesThe annotation queue ID
item_idUUIDYesThe queue item ID

Request Body

FieldTypeRequiredDescription
annotationsarrayYesArray of annotation objects
annotations[].label_idUUIDYesThe annotation label ID
annotations[].valueanyYesThe annotation value (type depends on the label)
notesstringNoFree-text notes for this item

Response

FieldTypeDescription
submittedintegerNumber of annotations submitted

Code Examples

import requests

queue_id = "your-queue-uuid"
item_id = "your-item-uuid"
resp = requests.post(
    f"https://api.futureagi.com/model-hub/annotation-queues/{queue_id}/items/{item_id}/annotations/submit/",
    headers={"X-Api-Key": "YOUR_KEY", "X-Secret-Key": "YOUR_SECRET"},
    json={
        "annotations": [
            {"label_id": "label-uuid", "value": "good"}
        ],
        "notes": "Looks correct."
    }
)
print(resp.json())
import axios from 'axios';

const queueId = 'your-queue-uuid';
const itemId = 'your-item-uuid';
const resp = await axios.post(
  `https://api.futureagi.com/model-hub/annotation-queues/${queueId}/items/${itemId}/annotations/submit/`,
  {
    annotations: [{ labelId: 'label-uuid', value: 'good' }],
    notes: 'Looks correct.'
  },
  { 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/items/your-item-uuid/annotations/submit/" \
  -H "X-Api-Key: YOUR_KEY" \
  -H "X-Secret-Key: YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"annotations": [{"label_id": "label-uuid", "value": "good"}], "notes": "Looks correct."}'
Was this page helpful?

Questions & Discussion