Download a dataset version
Streams a dataset version's items as a downloadable file (Content-Disposition: attachment; filename="<dataset_version_id>.<format>"). The body is the array of item data objects, serialized as a JSON array (format=json, the default) or as newline-delimited JSON (format=jsonl).
Authorization
personalAccessToken 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 UUID.
Query Parameters
File format for the exported items.
Response Body
application/octet-stream
application/json
application/json
application/json
curl -X GET "https://example.com/v1/dataset-versions/497f6eca-6276-4993-bfeb-53cbbbba6f08/download""string"{
"error": {
"code": "bad_request",
"message": "Bad Request",
"details": {
"input": "cannot be blank"
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"error": {
"code": "not_found",
"message": "Not Found"
}
}Update a dataset version
Replaces a draft version's item `schema`. Only draft versions are editable; updating a released version returns `400`. The new schema must remain compatible with every existing item, otherwise the request is rejected.
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.