Search documentation
karat

+

K

User Documentation ↗
Version 1.0

Create Dataset

POST/api/v1/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

name
string
parentFolderRid
string

Response body

Dataset
object
Hide child attributes

Hide child attributes

rid
string

The Resource Identifier (RID) of a Dataset.

name
string
parentFolderRid
string

Examples

Request

Copied!
1curl -X POST \ 2 -H "Content-type: application/json" \ 3 -H "Authorization: Bearer $TOKEN" \ 4 "https://$HOSTNAME/api/v1/datasets" \ 5 -d '{"name":"My Dataset","parentFolderRid":"ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4"}'

Response

Copied!
1{ 2 "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", 3 "path": "/Empyrean Airlines/My Important Project/My Dataset" 4}

Error responses

Error Name
InvalidBranchIdError CodeINVALID_ARGUMENT
Status Code400
DescriptionThe requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs.
ParametersbranchId
TransactionNotCommittedError CodeINVALID_ARGUMENT
Status Code400
DescriptionThe given transaction has not been committed.
ParametersdatasetRid, transactionRid, transactionStatus
TransactionNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested transaction could not be found on the dataset, or the client token does not have access to it.
ParametersdatasetRid, transactionRid
DatasetNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested dataset could not be found, or the client token does not have access to it.
ParametersdatasetRid
CreateBranchPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionThe provided token does not have permission to create a branch of this dataset.
ParametersdatasetRid, branchId
BranchAlreadyExistsError CodeCONFLICT
Status Code409
DescriptionThe branch cannot be created because a branch with that name already exists.
ParametersdatasetRid, branchId
ResourceNameAlreadyExistsError CodeCONFLICT
Status Code409
DescriptionThe provided resource name is already in use by another resource in the same folder.
ParametersparentFolderRid, resourceName
FolderNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested folder could not be found, or the client token does not have access to it.
ParametersfolderRid
CreateDatasetPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionThe provided token does not have permission to create a dataset in this folder.
ParametersparentFolderRid, name