Experiment Runs API Reference Overview - Platform For AI

Retrieves a list of runs.

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

GET /api/v1/runs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the run.	myName
WorkspaceId	string	No	The ID of the workspace where the experiment resides. For more information about how to obtain a workspace ID, see ListWorkspaces. Note If you do not specify a workspace ID, the system returns the list of runs in the default workspace.	228**
ExperimentId	string	No	The ID of the experiment to which the run belongs.	exp-1zpfthdx******
SourceType	string	No	The type of the PAI workload associated with the run.	TrainingService
SourceId	string	No	The ID of the PAI workload associated with the run.	job-rbvg5wzlj****
Labels	string	No	The labels of the run for an exact match. The following formats are supported: Single-label query: "is_evaluation:true" Multi-label query: "is_evaluation:true,LLM_evaluation:true". This method is not recommended for common scenarios because it may degrade performance. Use commas (,) to separate multiple labels. The system matches all specified key-value pairs.	is_evaluation:true
Verbose	boolean	No	Specifies whether to display details, including Metrics, Params, and Labels. Valid values: true: displays details. false (default): does not display details.	true
GmtCreateTime	string	No	The time when the instance was created.	2021-01-30T12:51:33.028Z
OrderBy	string	No	The fields to sort by and the sort order. You can sort by GmtCreateTime and Name. Valid sort orders are DESC and ASC. The default is ASC. To sort by multiple fields, separate them with a comma (,).	GmtCreateTime DESC,Name ASC
PageToken	integer	No	The paging token. The value starts from 0. The default value is 0.	0
MaxResults	integer	No	The maximum number of results to return. The default value is 10.	10
PageNumber	integer	No	The page number. The value must be greater than 0. Default value: 1.	1
PageSize	integer	No	The number of records to display on each page.	10
SortBy	string	No	The field to use for sorting. Valid values: Name: the name of the run. GmtCreateTime (default): the time when the run was created.	GmtCreateTime
Order	string	No	The sort order for the paged query. Use this parameter with SortBy. ASC: ascending order. DESC (default): descending order.	DESC

Response elements

Element	Type	Description	Example
	object	The response.
requestId	string	The request ID.	ADF6D849-*****-7E7030F0CE53
Runs	array	The list of runs.
	Run	The details of the run instance.
TotalCount	integer	The total number of entries that meet the filter criteria. This parameter is optional and may not be returned.	1
NextPageToken	integer	The paging token. For the first query, leave this parameter empty. The token for the next page is returned in the response. If the returned token is 0, all results have been returned. You can obtain the token for the next page from the NextPageToken field in the response.	0

Examples

Success response

JSON format

{
  "requestId": "ADF6D849-*****-7E7030F0CE53",
  "Runs": [
    {
      "Accessibility": "PRIVATE",
      "SourceId": "train9s0afvjkf",
      "SourceType": "TrainingService",
      "WorkspaceId": "145883",
      "Params": [
        {
          "Value": "",
          "Key": ""
        }
      ],
      "Labels": [
        {
          "Value": "",
          "RunId": "",
          "GmtCreateTime": "",
          "GmtModifiedTime": "",
          "Key": ""
        }
      ],
      "GmtModifiedTime": "2021-01-30T12:51:33.028Z",
      "Name": "testrun",
      "Metrics": [
        {
          "Value": 0,
          "Step": 0,
          "Timestamp": 0,
          "Key": ""
        }
      ],
      "OwnerId": "1631044****3440",
      "ExperimentId": "exp-1zpfthdx******",
      "UserId": "",
      "RunId": "run-1qJhzJ2YXgX****",
      "GmtCreateTime": "2021-01-30T12:51:33.028Z",
      "RequestId": "5A14FA81-DD4E-******-6343FE44B941"
    }
  ],
  "TotalCount": 1,
  "NextPageToken": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.