Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Model Studio Config Version

GET/api/v2/models/modelStudios/{modelStudioRid}/configVersions/{modelStudioConfigVersionVersion}
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 a specific Model Studio configuration version.

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.

modelStudioConfigVersionVersion
integer

The version number of this configuration.

Query parameters

preview
booleanoptional

Enables the use of preview functionality.

Response body

ModelStudioConfigVersion
object
Hide child attributes

Hide child attributes

name
string

Human readable name of the configuration version and experiment.

version
integer

The version number of this configuration.

trainerId
string

The identifier of the trainer to use for this configuration.

trainer
object

The trainer and version used for this configuration.

Show child attributes

Show child attributes

workerConfig
object

The worker configuration including inputs, outputs, and custom settings.

Show child attributes

Show child attributes

resources
object

The compute resources allocated for training runs.

Show child attributes

Show child attributes

changelog
stringoptional

Changelog describing changes in this version.

createdBy
string

The Foundry user who created this resource

createdTime
string

The time at which the resource was created.

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/configVersions/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 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 { "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "trainer": { "trainerId": "ri.models..trainer.autogluon_tabular_regression", "version": "0.388.0" }, "name": "Initial configuration", "resources": { "memory": "4G", "cpu": "2" }, "createdTime": "2003-05-06T12:34:56.789Z", "version": 1, "workerConfig": { "outputs": { "model": { "type": "model", "modelRid": "ri.models.main.model.a1b2c3d4-e5f6-7890-abcd-ef1234567890" } }, "inputs": { "input_df": { "type": "dataset", "rid": "ri.foundry.main.dataset.a1b2c3d4-e5f6-7890-abcd-ef1234567890", "columnMapping": { "target_column": [ "target" ] }, "ignoreColumns": [], "selectColumns": [] } } }, "trainerId": "ri.models..trainer.autogluon_tabular_regression" }

Error responses

Error Name
ModelStudioNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested Model Studio was not found.
ParametersstudioRid
ModelStudioConfigVersionNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given ModelStudioConfigVersion could not be found.
ParametersmodelStudioConfigVersionVersion, modelStudioRid