Run a workflow instance

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this API and some common parameters are listed below. For more information, see Common parameters.

Action string required Example value: RunWorkflowInstance

The operation to be performed. Value: RunWorkflowInstance.

Version string required Example value: 2025-08-15

API version. Value: 2025-08-15.

Name string required Example value: workflow_instance_name

Workflow instance name

RunEnvs object[] Optional Example value: [ { "Name": "key1", "Value": "value1" } ]

Deprecated. The workflow instance runtime environment variables will override or be appended to the environment variables of all task instances under it.

Name string required Example value: Key

Name

Value string required Example value: Value

Value

WorkflowId string required Example value: wf-tpl-xxx

Workflow ID

ClientToken string Optional Example value: uuid-xxxxxx

Client token

WorkflowRunEnvs object[] Optional Example value: [ { "Key": "key1", "Value": "value1" } ]

Has higher priority than RunEnvs and will completely override RunEnvs. The workflow instance runtime environment variables will override or be appended to the environment variables of all task instances under it.

Key string required Example value: name1

Key

Value string required Example value: value1

Value

Response parameters

Only the response parameters specific to this API are listed below. For more information, see Response structure.

WorkflowInstanceId string Example value: wf-tpl-xxx-yy

Workflow instance ID

Request example

Response example

Error codes

The table below lists the error codes related to the business logic of this API. For common error codes, see the Common error codes documentation.

Status code	Error codes	Error message	Note
400	MissingParameter	The required parameter {} is missing.	The required parameter {} is missing.
400	InvalidRequestParam	Invalid request param {}, cause {}	Illegal request parameter {}, reason {}
400	DryRunOperation	The request is validated by a dryrun operation.	This request is validated by a dryrun operation.
400	InvalidParameter	The specified parameter {} is invalid.	The specified parameter {} is invalid.
500	InternalError	The request has failed due to an unknown error.	The request failed due to an unknown error.

Lake AI Service