Dynamiq
Datasets

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.

POST
/v1/dataset-versions/{dataset_version_id}/release

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.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/dataset-versions/497f6eca-6276-4993-bfeb-53cbbbba6f08/release"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
    "version": 0,
    "status": "draft",
    "schema": {
      "type": "any",
      "properties": {
        "property1": {
          "type": "any",
          "properties": {},
          "required": true
        },
        "property2": {
          "type": "any",
          "properties": {},
          "required": true
        }
      },
      "required": true
    },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "created_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    },
    "updated_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  }
}
{
  "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"
  }
}

Fork a dataset version

Creates a new draft version of the same dataset, copying the source version's schema and every item. Use this to derive an editable draft from a released version. The fork is always created as a draft, regardless of the source's status.

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.