Version 2.0

Get Model Studio

GET/api/v2/models/modelStudios/{modelStudioRid}

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.

Gets details about a Model Studio by its RID.

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

Path parameters

modelStudioRid

string

The Resource Identifier (RID) of a Model Studio.

Query parameters

preview

booleanoptional

Enables the use of preview functionality.

Response body

ModelStudio

object

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 \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/models/modelStudios/ri.models.main.model-studio.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true"

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
`ModelStudioNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given ModelStudio could not be found.
	Parameters	`modelStudioRid`

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