Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Model

GET/api/v2/models/{modelRid}
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.

Retrieves a Model by its Resource Identifier (RID).

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

Path parameters

modelRid
string

The Resource Identifier (RID) of a Model.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

Model
object
Hide child attributes

Hide child attributes

rid
string

The Resource Identifier (RID) of a Model.

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9?preview=true"

Response

Copied!
1 2 3 { "rid": "ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9" }

Error responses

Error Name
ModelNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Model could not be found.
ParametersmodelRid