Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Create Model Studio

POST/api/v2/models/modelStudios
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 Model Studio.

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

Query parameters

preview
booleanoptional

Enables the use of preview functionality.

Request body

CreateModelStudioRequest
object
Hide child attributes

Hide child attributes

name
string

The name of the Model Studio.

parentFolderRid
string

The RID of the parent folder where the studio will be created.

Response body

ModelStudio
object

The created ModelStudio

Hide child attributes

Hide child attributes

rid
string

The Resource Identifier (RID) of a Model Studio.

folderRid
string

The parent folder containing this Model Studio.

createdTime
string

The time at which the resource was created.

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ \t-H "Content-type: application/json" \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/models/modelStudios?preview=true" \ -d '{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}'

Response

Copied!
1 2 3 4 5 { "createdTime": "2003-05-06T12:34:56.789Z", "rid": "ri.models.main.model-studio.a1b2c3d4-e5f6-7890-abcd-ef1234567890", "folderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791" }

Error responses

Error Name
ResourceNameAlreadyExistsError CodeCONFLICT
Status Code409
DescriptionThe provided resource name is already in use by another resource in the same folder.
ParametersparentFolderRid, displayName
InvalidDisplayNameError CodeINVALID_ARGUMENT
Status Code400
DescriptionThe display name of a Resource should not be exactly `.` or `..`, contain a forward slash `/` and must be less than or equal to 700 characters.
ParametersdisplayName
InvalidModelStudioCreateRequestError CodeINVALID_ARGUMENT
Status Code400
DescriptionThe request to create a Model Studio contains invalid arguments.
Parameters
CreateModelStudioPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not create the ModelStudio.
Parameters