Update Task

PUThttps://api.confident-ai.com/v2/annotation-queues/{annotationQueueId}/queue-ingestion-tasks/{queueIngestionTaskId}

Updates an ingestion task and returns it. A field you omit keeps its stored value; items already queued by the task are kept whatever you change.

PUT/v2/annotation-queues/{annotationQueueId}/queue-ingestion-tasks/{queueIngestionTaskId}

curl -X PUT "https://api.confident-ai.com/v2/annotation-queues/{annotationQueueId}/queue-ingestion-tasks/{queueIngestionTaskId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Failed capital lookups",
  "dataModel": "TRACE",
  "description": "Traces where the assistant failed to name a capital.",
  "enabled": true,
  "sampleRate": 0.1,
  "filters": {
    "operator": "AND",
    "groups": [
      {
        "operator": "AND",
        "filters": [
          {
            "category": "Name",
            "condition": "Is",
            "value": "capital-lookup"
          }
        ]
      }
    ]
  },
  "maxItems": 500,
  "assignmentStrategy": "SINGLE_USER",
  "reviewerEmails": [
    "jane@acme.com"
  ]
}'

200

{
  "success": true,
  "data": {
    "id": "<QUEUE-INGESTION-TASK-ID>",
    "name": "Failed capital lookups",
    "description": "Traces where the assistant failed to name a capital.",
    "enabled": true,
    "sampleRate": 0.1,
    "dataModel": "TRACE",
    "filters": {
      "operator": "AND",
      "groups": [
        {
          "operator": "AND",
          "filters": [
            {
              "category": "User Id",
              "condition": "Is less than",
              "value": "string",
              "key": "string"
            }
          ]
        }
      ]
    },
    "maxItems": 500,
    "assignmentStrategy": "SINGLE_USER",
    "reviewers": [
      {
        "id": "<USER-ID>",
        "email": "jane@acme.com",
        "name": "Jane Doe",
        "image": null
      }
    ],
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-16T09:00:00.000Z"
  },
  "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.

Path parameters

annotationQueueIdstringRequired
The id of the annotation queue the task fills.
queueIngestionTaskIdstringRequired
The id of the queue ingestion task.

Request body

namestring
The name of the task.
dataModelenum
What kind of production item an ingestion task harvests. THREAD tasks fill multi-turn datasets; TRACE and SPAN tasks fill single-turn ones.
Show 3 enum valuesHide 3 enum values
- TRACE
- SPAN
- THREAD
descriptionstring | null
A note about what the task harvests. Send null to clear it.
enabledboolean
Whether the task runs. Disabling it stops new items arriving; items already queued are kept. Defaults to false.
sampleRatenumber
The fraction of matching items to queue, between 0 and 1. Defaults to 1, all of them.
filtersobject
A set of filter groups combined by a top-level operator. Each group combines its filter rows by its own operator, and each row matches one property, such as Name or User Id, against a value with a condition such as Is or Contains.
Show 2 propertiesHide 2 properties
- operatorenumRequired
  Show 2 enum valuesHide 2 enum values
  - AND
  - OR
- groupslist of objectsRequired
  Show 2 propertiesHide 2 properties
  - operatorenumRequired
    Show 2 enum valuesHide 2 enum values
    AND
    OR
  - filterslist of objectsRequired
    Show 4 propertiesHide 4 properties
    categoryenumRequired
    Show 80 enum valuesHide 80 enum values
    User Id
    Thread Id
    Trace Uuid
    Trace Name
    Trace Version
    Trace Status
    Trace Tags
    Trace
    Span Uuid
    Name
    Span Name
    Span Type
    Span Status
    Metrics Status
    Error Status
    Name
    Model
    Provider
    Integration
    Embedder
    Chunk Size
    Top-K
    Hyperparameter
    Dataset
    Dataset Name
    Test Run ID
    Identifier
    Test File
    Status
    Official
    Evals Mode
    Tests Passed
    Tests Failed
    Pass Rate
    Fail Rate
    Star Rating
    Thumbs Rating
    Explanation
    Expected Output
    Expected Outcome
    Annotator
    End User
    Annotation Type
    Annotation Name
    Criteria
    Annotation Date
    Metric Score
    Metric Status
    Name
    Metadata
    Classifier
    Metric
    Metric Name
    Trace Count
    Test Case ID
    Requested review from
    Assigned to
    Tags
    Labels
    Tools Called
    Finalized
    Golden ID
    Ingestion Task
    Latency
    Environment
    Review flag
    Vulnerability
    Vulnerability Type
    Attack Method
    Risk Category
    Framework
    Assessment ID
    Prompt Alias
    Prompt Version
    Prompt Label
    Prompt Commit Hash
    Prompt
    Annotations
    Status Code
    Actor Type
    conditionenum | enum | enum | enum | enum | enum | enum | enum | enum | enumRequired
    Show 10 variantsHide 10 variants
    enum
    Show 6 enum valuesHide 6 enum values
    Is less than
    Is equal or less than
    Is greater than
    Is equal or greater than
    Is equal to
    Does not equal
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Has
    Has not
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Is
    Is not
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Is one of
    Is not one of
    OR
    enum
    Show 4 enum valuesHide 4 enum values
    Is
    Is not
    Is empty
    Is not empty
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Contains
    Does not contain
    OR
    enum
    Show 3 enum valuesHide 3 enum values
    Contains
    Contains only
    Does not contain
    OR
    enum
    Show 4 enum valuesHide 4 enum values
    Has decreased by more than
    Has decreased by less than
    Has increased by more than
    Has increased by less than
    OR
    enum
    Show 1 enum valueHide 1 enum value
    Has changed from
    OR
    enum
    Show 1 enum valueHide 1 enum value
    Is between
    valuestring | number | list of stringsRequired
    Show 3 variantsHide 3 variants
    string
    OR
    number
    OR
    list of strings
    keystring
maxItemsinteger | null
The maximum number of items this task will ever queue. Send null to remove the cap.
assignmentStrategyenum
How harvested items are shared out among the reviewers: SINGLE_USER gives every item to one reviewer, ROUND_ROBIN deals them out in turn, and RANDOM assigns each one at random.
Show 3 enum valuesHide 3 enum values
- SINGLE_USER
- ROUND_ROBIN
- RANDOM
reviewerEmailslist of strings
The project members harvested items are assigned to, following assignmentStrategy.

Response

Update Task succeeded.

successboolean
Indicates if the request was successful.
dataobject
A rule that keeps an annotation queue filled from your production data.
Show 12 propertiesHide 12 properties
- idstring
  The id of the task, generated by Confident AI.
- namestring
  The name of the task.
- descriptionstring | null
  A note about what the task harvests.
- enabledboolean
  Whether the task is running.
- sampleRatenumber
  The fraction of matching items the task queues.
- dataModelenum
  What kind of production item an ingestion task harvests. THREAD tasks fill multi-turn datasets; TRACE and SPAN tasks fill single-turn ones.
  Show 3 enum valuesHide 3 enum values
  - TRACE
  - SPAN
  - THREAD
- filtersobject | null
  A set of filter groups combined by a top-level operator. Each group combines its filter rows by its own operator, and each row matches one property, such as Name or User Id, against a value with a condition such as Is or Contains.
  Show 2 propertiesHide 2 properties
  - operatorenum
    Show 2 enum valuesHide 2 enum values
    AND
    OR
  - groupslist of objects
    Show 2 propertiesHide 2 properties
    operatorenum
    Show 2 enum valuesHide 2 enum values
    AND
    OR
    filterslist of objects
    Show 4 propertiesHide 4 properties
    categoryenum
    Show 80 enum valuesHide 80 enum values
    User Id
    Thread Id
    Trace Uuid
    Trace Name
    Trace Version
    Trace Status
    Trace Tags
    Trace
    Span Uuid
    Name
    Span Name
    Span Type
    Span Status
    Metrics Status
    Error Status
    Name
    Model
    Provider
    Integration
    Embedder
    Chunk Size
    Top-K
    Hyperparameter
    Dataset
    Dataset Name
    Test Run ID
    Identifier
    Test File
    Status
    Official
    Evals Mode
    Tests Passed
    Tests Failed
    Pass Rate
    Fail Rate
    Star Rating
    Thumbs Rating
    Explanation
    Expected Output
    Expected Outcome
    Annotator
    End User
    Annotation Type
    Annotation Name
    Criteria
    Annotation Date
    Metric Score
    Metric Status
    Name
    Metadata
    Classifier
    Metric
    Metric Name
    Trace Count
    Test Case ID
    Requested review from
    Assigned to
    Tags
    Labels
    Tools Called
    Finalized
    Golden ID
    Ingestion Task
    Latency
    Environment
    Review flag
    Vulnerability
    Vulnerability Type
    Attack Method
    Risk Category
    Framework
    Assessment ID
    Prompt Alias
    Prompt Version
    Prompt Label
    Prompt Commit Hash
    Prompt
    Annotations
    Status Code
    Actor Type
    conditionenum | enum | enum | enum | enum | enum | enum | enum | enum | enum
    Show 10 variantsHide 10 variants
    enum
    Show 6 enum valuesHide 6 enum values
    Is less than
    Is equal or less than
    Is greater than
    Is equal or greater than
    Is equal to
    Does not equal
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Has
    Has not
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Is
    Is not
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Is one of
    Is not one of
    OR
    enum
    Show 4 enum valuesHide 4 enum values
    Is
    Is not
    Is empty
    Is not empty
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Contains
    Does not contain
    OR
    enum
    Show 3 enum valuesHide 3 enum values
    Contains
    Contains only
    Does not contain
    OR
    enum
    Show 4 enum valuesHide 4 enum values
    Has decreased by more than
    Has decreased by less than
    Has increased by more than
    Has increased by less than
    OR
    enum
    Show 1 enum valueHide 1 enum value
    Has changed from
    OR
    enum
    Show 1 enum valueHide 1 enum value
    Is between
    valuestring | number | list of strings
    Show 3 variantsHide 3 variants
    string
    OR
    number
    OR
    list of strings
    keystring
- maxItemsinteger | null
  The maximum number of items this task will queue, or null when it is uncapped.
- assignmentStrategyenum
  How harvested items are shared out among the reviewers: SINGLE_USER gives every item to one reviewer, ROUND_ROBIN deals them out in turn, and RANDOM assigns each one at random.
  Show 3 enum valuesHide 3 enum values
  - SINGLE_USER
  - ROUND_ROBIN
  - RANDOM
- reviewerslist of objects
  The project members harvested items are assigned to, in the order the strategy deals them out.
  Show 4 propertiesHide 4 properties
  - idstring
    This is the id of the user.
  - emailstring
    This is the email address of the user.
  - namestring | null
    This is the display name of the user, or null when they have not set one.
  - imagestring | null
    This is the URL of the user's avatar, or null when they have none.
- createdAtstring
  When the task was created.
- updatedAtstring
  When the task was last changed.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI