CreateRun

Updated at:

Creates a run for an experiment. The run can be associated with a specific workload or be a standalone code execution.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /api/v1/runs HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request struct.

Name

string

No

The name of the run. The naming convention is as follows:

  • Starts with a lowercase or uppercase letter.

  • Can contain lowercase letters, uppercase letters, digits, underscores (_), and hyphens (-).

  • The length must be 1 to 63 characters.

If this parameter is left empty, the server-generated random ID (RunID) is used as the name.

myName

SourceType

string

No

The source type of the PAI workload associated with the run. Options include TrainingService, DLC, or empty. This parameter is optional. The default value is empty.

DLC

SourceId

string

No

The ID of the PAI workload associated with the run.

job-jdnhf***fnrimv

ExperimentId

string

Yes

The ID of the experiment associated with the run.

exp-6thbb5xrbmp*****

Labels

array

No

The list of labels for the run.

Label

No

The details of the label.

Params

array

No

The list of parameters for the run.

RunParam

No

The details of the parameter.

Response elements

Element

Type

Description

Example

object

Schema of Response

requestId

string

Id of the request

ADF6D849-*****-7E7030F0CE53

RunId

string

The ID of the run.

run-1meoz7VJd2C6f****

Examples

Success response

JSON format

{
  "requestId": "ADF6D849-*****-7E7030F0CE53",
  "RunId": "run-1meoz7VJd2C6f****"
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.