CreateExperiment

Updated at:

Creates an experiment.

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/experiments HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

WorkspaceId

string

Yes

The workspace ID.

478**

Labels

array

No

The labels.

LabelInfo

No

A label.

Name

string

Yes

The name of the experiment. The name must meet the following requirements:

  • Start with an uppercase or lowercase letter.

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

  • Be 1 to 63 characters in length.

exp-test

ArtifactUri

string

No

The default output path of artifacts for all tasks that are associated with the experiment. Only Object Storage Service (OSS) paths are supported.

oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/test

Accessibility

string

No

The visibility of the experiment. It can be PRIVATE (visible only to the creator and the creator's Alibaba Cloud account) or PUBLIC (visible to all users). This parameter is optional. The default value is PRIVATE.

PRIVATE

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

请求ID

ExperimentId

string

If the call is asynchronous, the API returns a JobId.

API请求完成创建的实验ID

Examples

Success response

JSON format

{
  "RequestId": "请求ID",
  "ExperimentId": "API请求完成创建的实验ID"
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.