Sign in

v1

latestOpenAPI 3.1.02026-07-173384141.4 KB
datasets

put/documents/v2/datasets/{dataset_id}

Path parameters

dataset_idstring required

The ID of the dataset to update

Request body

descriptionstring nullable

A description of the dataset.

This field is optional and can be used to provide additional context about the dataset.

Example request

{
  "description": "This dataset contains all invoices from 2023."
}

Response

Dataset updated successfully

namestring required

The name of the dataset.

This is a human-readable name that identifies the dataset.

dataset_idstring required

The unique identifier for the dataset.

This identifier is used to refer to the dataset in API endpoints and operations.

This value is automatically generated and is unique within the organization and project context.

descriptionstring nullable

An optional description of the dataset.

This description is the one provided during dataset creation or update.

status'idle' | 'processing' required
created_atstring required

The date and time when the dataset was created.

The data is in RFC 3339 format (e.g., "2023-10-01T12:00:00Z").

updated_atstring required

The date and time when the dataset was last updated.

The data is in RFC 3339 format (e.g., "2023-10-01T12:00:00Z").

Example response

{
  "name": "Invoices Dataset",
  "dataset_id": "dataset_12345",
  "description": "This dataset contains invoices for the year 2023.",
  "created_at": "2023-10-01T12:00:00Z",
  "updated_at": "2023-10-01T12:00:00Z"
}