Update Dataset Ingestion Task

(v2)

PUT

Updates an ingestion task and returns it. Only the fields you send are changed, and at least one is required; send null to clear a nullable field. Toggling enabled schedules or unschedules the harvesting job.

PUT/v2/datasets/{datasetId}/dataset-ingestion-tasks/{datasetIngestionTaskId}

curl -X PUT "https://api.confident-ai.com/v2/datasets/{datasetId}/dataset-ingestion-tasks/{datasetIngestionTaskId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Harvest failed 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"
          }
        ]
      }
    ]
  },
  "maxGoldens": 500,
  "inputTransformerId": "<TRANSFORMER-ID>",
  "outputTransformerId": null,
  "includeInput": true,
  "includeActualOutput": true,
  "includeExpectedOutput": false,
  "includeRetrievalContext": false,
  "includeContext": false,
  "includeToolsCalled": false,
  "includeExpectedTools": false
}'

200

{
  "success": true,
  "data": {
    "id": "<DATASET-INGESTION-TASK-ID>",
    "name": "Harvest failed 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"
            }
          ]
        }
      ]
    },
    "maxGoldens": 500,
    "inputTransformerId": "<TRANSFORMER-ID>",
    "outputTransformerId": null,
    "includeInput": true,
    "includeActualOutput": true,
    "includeExpectedOutput": false,
    "includeRetrievalContext": false,
    "includeContext": false,
    "includeToolsCalled": false,
    "includeExpectedTools": false,
    "createdAt": "2026-05-28T13:05:24.777Z",
    "updatedAt": "2026-05-28T13:35:16.268Z"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/workflows",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

datasetIdstringRequired
The unique id of the dataset.
datasetIngestionTaskIdstringRequired
The unique id of the ingestion task.

Request body

namestring
A new name for the task, unique within the dataset.
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 unschedules the harvesting job, and goldens already created are kept. Defaults to false on create; omit it on an update to leave it unchanged.
sampleRatenumber
The fraction of matching items to ingest, between 0 and 1. On create it defaults to 1, all of them; omit it on an update to leave it unchanged.
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
  How the groups combine: AND matches a record only when every group matches it, and OR matches it when any one group does.
  Show 2 enum valuesHide 2 enum values
  - AND
  - OR
- groupslist of objectsRequired
  The groups of filters to apply, each combining its own filters with its own operator.
  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 100 enum valuesHide 100 enum values
    User Id
    Customer Id
    Customer Name
    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
    Called tool
    Handed off to
    Handed off by
    Nearest parent of type
    Anywhere under
    Top level
    Name
    Model
    Provider
    Integration
    Input argument
    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
    Annotation Date
    Annotation Rating
    Annotation Thumbs
    Annotation Choice
    Annotation Yes / No
    Annotation Text
    Metric Score
    Metric Status
    Metric Version
    Name
    Metadata
    Classifier
    Classifier Version
    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
    Failure Mode
    Recommended
    Sub-mode Name
    Sub-mode Recommended
    Sub-mode Certainty
    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
maxGoldensinteger | null
The maximum number of goldens this task will ever create. Send null to remove the cap.
inputTransformerIdstring | null
The id of a transformer that reshapes the harvested input before it is stored. Send null to detach it.
outputTransformerIdstring | null
The id of a transformer that reshapes the harvested output before it is stored. Send null to detach it.
includeInputboolean
Populate the golden's input from the harvested item. On create it defaults to true and every other include flag defaults to false; omit it on an update to leave it unchanged.
includeActualOutputboolean
Populate the golden's actualOutput from the harvested item.
includeExpectedOutputboolean
Populate the golden's expectedOutput from the harvested item.
includeRetrievalContextboolean
Populate the golden's retrievalContext from the harvested item.
includeContextboolean
Populate the golden's context from the harvested item.
includeToolsCalledboolean
Populate the golden's toolsCalled from the harvested item.
includeExpectedToolsboolean
Populate the golden's expectedTools from the harvested item.

Response

Update Dataset Ingestion Task succeeded.

successboolean
Indicates if the request was successful.
dataobject
An ingestion task: which production items it harvests into the dataset, how it samples them, and which golden fields it fills.
Show 19 propertiesHide 19 properties
- idstring
  The unique id of the ingestion task.
- namestring
  The name of the ingestion task, unique within the dataset.
- descriptionstring | null
  A note about what the task harvests, or null.
- enabledboolean
  Whether the task is currently harvesting.
- sampleRatenumber
  The fraction of matching items the task ingests, between 0 and 1.
- 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
    How the groups combine: AND matches a record only when every group matches it, and OR matches it when any one group does.
    Show 2 enum valuesHide 2 enum values
    AND
    OR
  - groupslist of objects
    The groups of filters to apply, each combining its own filters with its own operator.
    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 100 enum valuesHide 100 enum values
    User Id
    Customer Id
    Customer Name
    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
    Called tool
    Handed off to
    Handed off by
    Nearest parent of type
    Anywhere under
    Top level
    Name
    Model
    Provider
    Integration
    Input argument
    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
    Annotation Date
    Annotation Rating
    Annotation Thumbs
    Annotation Choice
    Annotation Yes / No
    Annotation Text
    Metric Score
    Metric Status
    Metric Version
    Name
    Metadata
    Classifier
    Classifier Version
    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
    Failure Mode
    Recommended
    Sub-mode Name
    Sub-mode Recommended
    Sub-mode Certainty
    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
- maxGoldensinteger | null
  The maximum number of goldens this task will ever create, or null when uncapped.
- inputTransformerIdstring | null
  The id of the transformer that reshapes the harvested input, or null when the task does not use one.
- outputTransformerIdstring | null
  The id of the transformer that reshapes the harvested output, or null when the task does not use one.
- includeInputboolean
  Whether the golden's input is populated from the harvested item.
- includeActualOutputboolean
  Whether the golden's actualOutput is populated from the harvested item.
- includeExpectedOutputboolean
  Whether the golden's expectedOutput is populated from the harvested item.
- includeRetrievalContextboolean
  Whether the golden's retrievalContext is populated from the harvested item.
- includeContextboolean
  Whether the golden's context is populated from the harvested item.
- includeToolsCalledboolean
  Whether the golden's toolsCalled is populated from the harvested item.
- includeExpectedToolsboolean
  Whether the golden's expectedTools is populated from the harvested item.
- createdAtstring
  When the task was created, as an ISO 8601 timestamp.
- updatedAtstring
  When the task was last updated, as an ISO 8601 timestamp.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI