Traceway
API Reference

Datasets

REST API endpoints for creating, listing, updating, and deleting datasets.

Create a dataset

POST /api/datasets
{
  "name": "golden-set",
  "description": "Curated test cases for the Q&A pipeline"
}
FieldRequiredTypeDescription
nameYesstringDataset name
descriptionNostringOptional description

Response:

{
  "id": "01J...",
  "name": "golden-set",
  "description": "Curated test cases for the Q&A pipeline",
  "datapoint_count": 0,
  "created_at": "2024-06-15T12:00:00Z",
  "updated_at": "2024-06-15T12:00:00Z"
}

List datasets

GET /api/datasets

Returns all datasets with their datapoint counts:

{
  "datasets": [
    {
      "id": "01J...",
      "name": "golden-set",
      "description": "Curated test cases",
      "datapoint_count": 42,
      "created_at": "2024-06-15T12:00:00Z",
      "updated_at": "2024-06-15T14:30:00Z"
    }
  ],
  "count": 1
}

Get a dataset

GET /api/datasets/:id

Returns the dataset metadata (same shape as the object in the list response).

Update a dataset

PUT /api/datasets/:id
{
  "name": "golden-set-v2",
  "description": "Updated test cases"
}

Both fields are optional. Only provided fields are updated.

Delete a dataset

DELETE /api/datasets/:id

Deletes the dataset and all its datapoints, queue items, capture rules, and eval runs. This is irreversible.

Returns 200 on success, 404 if not found.

On this page