Search documentation
karat

+

K

User Documentation ↗

Create Dataset

POST/api/v2/datasets
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Creates a new Dataset. A default branch - master for most enrollments - will be created on the Dataset.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-write.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

CreateDatasetRequest
object
Hide children

Hide children

parentFolderRid
string

The unique resource identifier (RID) of a Folder.

name
string

Response body

Dataset
object

The created Dataset

Hide children

Hide children

rid
string

The Resource Identifier (RID) of a Dataset.

name
string
parentFolderRid
string

The unique resource identifier (RID) of a Folder.

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/datasets?preview=true" \ -d ''

Response

Copied!
1 2 3 { "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" }