Create Annotation Queue

(v2)

POST

Creates an annotation queue in your Confident AI project and returns its id. The type you give it decides what can be added to it and cannot be changed afterwards.

POST/v2/annotation-queues

curl -X POST "https://api.confident-ai.com/v2/annotation-queues" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Failed geography answers",
  "type": "TRACE",
  "formId": "<ANNOTATION-FORM-ID>",
  "tags": [
    "geography",
    "week-12"
  ]
}'

200

{
  "success": true,
  "data": {
    "id": "<ANNOTATION-QUEUE-ID>"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/annotation-queues/<ANNOTATION-QUEUE-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request body

namestringRequired
The name of the queue, which must be unique in the project.
typeenumRequired
What a queue holds, fixed when it is created: TRACE, SPAN or THREAD queues are filled from your production data, while GOLDEN and TEST_CASE queues are filled by Confident AI. TEST_RUN is still accepted as an input alias for TEST_CASE.
Show 5 enum valuesHide 5 enum values
- TRACE
- SPAN
- THREAD
- GOLDEN
- TEST_CASE
formIdstring
The id of an annotation form in this project to ask of every item in the queue. Forms are created and managed in the Confident AI platform.
tagslist of strings
Tags to put on the queue. A tag that does not exist in the project yet is created.

Response

Create Annotation Queue succeeded.

successboolean
Indicates if the request was successful.
dataobject
A reference to an annotation queue by its id.
Show 1 propertyHide 1 property
- idstring
  The id of the queue, generated by Confident AI.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI