v5

latestOpenAPI 3.1.0MITraw.githubusercontent.com2025-07-24172759.4 KB

Datasets

Update a dataset

Update the details of a dataset by ID

post/v4/datasets/{id}

Path parameters

idstring uuid required

Dataset UUID

Example:123e4567-e89b-12d3-a456-426614174000

Dataset UUID

Request body

namestring

Dataset name

descriptionstring nullable

Dataset description

isGoldenboolean

Set the dataset as the golden dataset

isArchivedboolean

Archive the dataset

Example request

{
  "name": "Dataset - negative user feedback - 2025-04-01",
  "description": "Negative user feedback collected from our production environment",
  "isGolden": true,
  "isArchived": true
}

Response

Successful response

idstring uuid required

Dataset UUID

createdAtstring required

Creation timestamp (ISO 8601)

updatedAtstring required

Last update timestamp (ISO 8601)

namestring required

Dataset name

descriptionstring nullable required

Dataset description

archivedAtstring nullable required

Archive timestamp (ISO 8601)

pipelineIdstring required

Pipeline UUID

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-04-01T00:00:00.000Z",
  "updatedAt": "2025-04-01T00:00:00.000Z",
  "name": "Dataset - negative user feedback - 2025-04-01",
  "description": "Negative user feedback collected from our production environment",
  "archivedAt": "2025-04-01T00:00:00.000Z",
  "pipelineId": "123e4567-e89b-12d3-a456-426614174000"
}