Search documentation
karat

+

K

User Documentation ↗

Create Dataset

POST/api/v2/datasets

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.

Request body

CreateDatasetRequest
object
Hide child attributes

Hide child attributes

parentFolderRid
string

The unique resource identifier (RID) of a Folder.

name
string

Response body

Dataset
object

The created Dataset

Hide child attributes

Hide child attributes

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" \ -d '{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"My Dataset"}'

Response

Copied!
1 2 3 4 5 { "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791", "name": "My Dataset", "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" }