List Dataset Ingestion Tasks

GEThttps://api.confident-ai.com/v1/datasets/{alias}/dataset-ingestion-tasks

Lists the ingestion tasks on a dataset, newest first, as summary rows. Retrieve a task by id for its full configuration and the number of goldens it has created. Requires the Starter plan or above.

GET/v1/datasets/{alias}/dataset-ingestion-tasks

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

200

{
  "success": true,
  "data": {
    "datasetIngestionTasks": [
      {
        "id": "INGESTION-TASK-ID",
        "name": "Harvest failed checkouts",
        "enabled": true,
        "dataModel": "TRACE"
      }
    ]
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/workflows"
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

aliasstringRequired
The unique alias of the dataset.

Query parameters

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

Response

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- datasetIngestionTaskslist of objects
  The dataset'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 harvesting.
  - dataModelenum
    What kind of item the task harvests.
    Show 3 enum valuesHide 3 enum values
    TRACE
    SPAN
    THREAD
linkstring
A link to the workflows page.

Built byConfident AI