List Queue Ingestion Tasks

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

Lists the ingestion tasks on an annotation queue, newest first, as summary rows. Retrieve a task by id for its full configuration, its reviewers, and the number of items it has queued. Requires the Starter plan or above.

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

curl -X GET "https://api.confident-ai.com/v1/annotation-queues/{queueId}/queue-ingestion-tasks" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "queueIngestionTasks": [
      {
        "id": "QUEUE-INGESTION-TASK-ID",
        "name": "Review failed traces",
        "enabled": true,
        "dataModel": "TRACE"
      }
    ]
  },
  "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.

Query parameters

dataModelenum
Only return tasks routing this kind of item. Omit to return all of them.

Response

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- queueIngestionTaskslist of objects
  The queue's ingestion tasks, newest first, as summary rows.
  Show 4 propertiesHide 4 properties
  - idstring
    The unique identifier of the ingestion task.
  - namestring
    The name of the ingestion task.
  - enabledboolean
    Whether the task is currently routing items.
  - dataModelenum
    What kind of item the task routes.
    Show 3 enum valuesHide 3 enum values
    TRACE
    SPAN
    THREAD
linkstring
A link to the annotation queue.

Built byConfident AI