Version 2.0

Launch Model Studio

POST/api/v2/models/modelStudios/{modelStudioRid}/launch

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.

Launches a new training run for the Model Studio using the latest configuration version.

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

Path parameters

modelStudioRid

string

The Resource Identifier (RID) of a Model Studio.

Query parameters

preview

booleanoptional

Enables the use of preview functionality.

Response body

ModelStudioRun

object

Hide child attributes

runId

string

A unique identifier for this run, derived from the studio, config, and build.

buildRid

string

The RID of the build associated with this run.

jobRid

string

The RID of the job associated with this run.

configVersion

integer

The configuration version used for this run.

startedBy

string

The user who started this run.

startedTime

string

When this run was started.

buildStatus

string (enum)optional

Status of the build.

Enum values: RUNNING, SUCCEEDED, FAILED, CANCELED

resolvedOutputs

map<OutputAlias, ModelStudioRunOutput>optional

Map of alias to resolved output details (e.g., for models, contains the version RID and experiment).

Show child attributes

Examples

Request

Copied!

curl -X POST \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/models/modelStudios/ri.models.main.model-studio.a1b2c3d4-e5f6-7890-abcd-ef1234567890/launch?preview=true"

Response

Copied!

{
  "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"
}

Error responses

Error Name
`ModelStudioNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The requested Model Studio was not found.
	Parameters	`studioRid`
`LaunchModelStudioPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not launch the ModelStudio.
	Parameters	`modelStudioRid`

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