Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Model Studio Runs

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

Lists all runs for a Model Studio.

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

configVersion
integeroptional

Filter runs by configuration version.

pageSize
integeroptional

The page size to use for the endpoint.

pageToken
stringoptional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

preview
booleanoptional

Enables the use of preview functionality.

Response body

ListModelStudioRunsResponse
object
Hide child attributes

Hide child attributes

data
list<ModelStudioRun>optional
Show child attributes

Show child attributes

nextPageToken
stringoptional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/models/modelStudios/ri.models.main.model-studio.a1b2c3d4-e5f6-7890-abcd-ef1234567890/runs?configVersion=1&preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 { "data": [ { "startedTime": "2003-05-06T12:34:56.789Z", "configVersion": 1, "startedBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "buildRid": "ri.foundry-build.main.build.a1b2c3d4-e5f6-7890-abcd-ef1234567890", "resolvedOutputs": { "model": { "type": "model", "modelRid": "ri.models.main.model.a1b2c3d4-e5f6-7890-abcd-ef1234567890", "modelVersionRid": "ri.models.main.model-version.a1b2c3d4-e5f6-7890-abcd-ef1234567890" } }, "runId": "a1b2c3d4e5f6", "jobRid": "ri.foundry-build.main.job.a1b2c3d4-e5f6-7890-abcd-ef1234567890", "buildStatus": "RUNNING" } ], "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z" }

Error responses

Error Name
ModelStudioNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested Model Studio was not found.
ParametersstudioRid
ModelStudioConfigVersionNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested Model Studio configuration version was not found.
ParametersstudioRid, configVersion