Create Queue Ingestion Task

POSThttps://api.confident-ai.com/v1/annotation-queues/{queueId}/queue-ingestion-tasks

Creates a standing rule that routes matching production traces, spans, or threads into the annotation queue for human review, starting immediately unless enabled is false.

Task names are unique within a queue, and only TRACE, SPAN, and THREAD are supported — GOLDEN queues are filled from a dataset instead. Requires the Starter plan or above.

POST/v1/annotation-queues/{queueId}/queue-ingestion-tasks

curl -X POST "https://api.confident-ai.com/v1/annotation-queues/{queueId}/queue-ingestion-tasks" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Review failed traces",
  "dataModel": "TRACE",
  "sampleRate": 0.05,
  "assignmentStrategy": "SINGLE_USER",
  "reviewerEmails": [
    "reviewer@example.com"
  ]
}'

200

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

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

queueIdstringRequired
The unique identifier of the annotation queue to route items into.

Request body

descriptionstring
A note about what the task routes.
enabledboolean
Whether the task runs. Disabling it unschedules the job; items already queued are kept.
sampleRatenumber
The fraction of matching items to queue. Defaults to 1 (all of them).
filtersobject
A set of filter groups combined by a top-level operator.
Show 2 propertiesHide 2 properties
- operatorenumRequired
  How filters or groups are combined.
  Show 2 enum valuesHide 2 enum values
  - AND
  - OR
- groupslist of objectsRequired
  The filter groups.
  Show 2 propertiesHide 2 properties
  - operatorenumRequired
    How filters or groups are combined.
    Show 2 enum valuesHide 2 enum values
    AND
    OR
  - filterslist of objectsRequired
    The filter rows in this group.
    Show 4 propertiesHide 4 properties
    categorystringRequired
    The property a filter row matches on (e.g. "Name", "User Id", "Model", "Metadata"). The set of valid values depends on the line's dataModel.
    conditionenumRequired
    The comparison a filter row applies. Valid conditions depend on the category.
    Show 18 enum valuesHide 18 enum values
    Is
    Is not
    Is equal to
    Does not equal
    Is less than
    Is equal or less than
    Is greater than
    Is equal or greater than
    Has
    Has not
    Contains
    Contains only
    Does not contain
    Has increased by more than
    Has increased by less than
    Has decreased by more than
    Has decreased by less than
    Has changed from
    valuestring | number | list of stringsRequired
    The value to match against.
    Show 3 variantsHide 3 variants
    string
    OR
    number
    OR
    list of strings
    keystring
    The property key. Auto-populated from category when omitted; required for Metadata, Metric, and Classifier filters.
maxItemsinteger
The maximum number of items this task will ever queue. Send null to remove the cap.
assignmentStrategyenum
How queued items are assigned. SINGLE_USER sends everything to one reviewer; ROUND_ROBIN and RANDOM spread them across a pool. Defaults to SINGLE_USER.
Show 3 enum valuesHide 3 enum values
- SINGLE_USER
- ROUND_ROBIN
- RANDOM
reviewerEmailslist of strings
The reviewers, by email. They must already be members of the project. SINGLE_USER accepts at most one; ROUND_ROBIN and RANDOM require at least one. Re-sending the same reviewers preserves their existing assignment counts, so load balancing carries over an edit.
namestringRequired
A name for the task, unique within the queue.
dataModelenumRequired
What kind of item to route into the queue.
Show 3 enum valuesHide 3 enum values
- TRACE
- SPAN
- THREAD

Response

successboolean
Indicates if the ingestion task was successfully created.
dataobject
Show 1 propertyHide 1 property
- idstring
  The unique identifier of the created ingestion task.
linkstring
A link to the annotation queue.

Built byConfident AI