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

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

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!

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!

{
  "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
`ResourceNameAlreadyExists`	Error Code	`CONFLICT`
	Status Code	409
	Description	The provided resource name is already in use by another resource in the same folder.
	Parameters	`parentFolderRid, displayName`
`InvalidDisplayName`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The display name of a resource should not be exactly `.` or `..`, contain a forward slash `/` and must be less than or equal to 700 characters.
	Parameters	`displayName`
`InvalidModelStudioCreateRequest`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The request to create a Model Studio contains invalid arguments.
	Parameters
`CreateModelStudioPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not create the ModelStudio.
	Parameters

See Errors for a general overview of errors in the platform.