List Dataset Ingestion Tasks

(v2)

GET

Lists the ingestion tasks on the dataset as summary rows. Retrieve one by id for its full configuration. Requires the Starter plan or above.

GET/v2/datasets/{datasetId}/dataset-ingestion-tasks

curl -X GET "https://api.confident-ai.com/v2/datasets/{datasetId}/dataset-ingestion-tasks" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "datasetIngestionTasks": [
      {
        "id": "<DATASET-INGESTION-TASK-ID>",
        "name": "Harvest failed lookups",
        "enabled": true,
        "dataModel": "TRACE"
      }
    ]
  },
  "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.

Query parameters

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

Response

List Dataset Ingestion Tasks succeeded.

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- datasetIngestionTaskslist of objects
  This is the list of ingestion tasks on the dataset, newest first, as summary rows.
  Show 4 propertiesHide 4 properties
  - idstring
    The unique id of the ingestion task.
  - namestring
    The name of the ingestion task, unique within the dataset.
  - enabledboolean
    Whether the task is currently harvesting.
  - 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
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI