Dynamiq
Datasets

Update a dataset version schema

Incrementally edits a dataset version's item schema by adding and/or removing fields. Each add entry defines a field and its schema; each delete entry names a field to remove and, when delete_from_items is true, also strips that field from every existing item. The resulting schema must remain compatible with all existing items.

PUT
/v1/dataset-versions/{dataset_version_id}/schema

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Path Parameters

dataset_version_id*string

Dataset version UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Incremental additions to and removals from a version's item schema.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/dataset-versions/497f6eca-6276-4993-bfeb-53cbbbba6f08/schema" \  -H "Content-Type: application/json" \  -d '{}'
{
  "message": "updated"
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Release a dataset version

Releases a draft version, making it immutable and assigning it the next sequential `version` number for the dataset. The dataset's latest-version pointer is updated to the released version, so evaluations can target it. A version that is already released returns `400`. Released versions can no longer be edited or deleted — fork one to continue editing.

Add items to a dataset version

Appends rows to a draft version. Send a JSON body with an `items` array, or upload a `.json` / `.jsonl` file as multipart/form-data in the `file` field. Only draft versions accept new items. When the version has a schema, every item is validated against it; when it does not, the schema is inferred from the first batch of items.