Query automation task running details

Read the current status and generated output of an automated task running record.

HTTP
GET $CLOUDSIGMA_API_BASE/workspaces/{workspace_id}/agent-automation-runs/{run_id}

Before you call this API

Configure the regional API endpoint and authentication, and select the target workspace.

Obtain the run ID from the task’s run history.

Set the operation-specific values used in the request:

  • $WORKSPACE_ID: Target workspace ID, passed through the X-Workspace-ID header and also as workspace_id in the path.

  • $RUN_ID: The running record ID to be queried, as run_id in the path.

Request

Shell
curl "$CLOUDSIGMA_API_BASE/workspaces/$WORKSPACE_ID/agent-automation-runs/$RUN_ID" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Path parameters

Parameters

Type

Is it required

Description

workspace_id

string

Yes

Workspace ID.

run_id

string

Yes

Run record ID.

Successful response

Returns 200 on success. When the run has produced output, it can contain final_text, structured_output, artifact_refs, or error.

JSON
{
  "code": 0,
  "data": {
    "id": "run_01",
    "workspace_id": "ws_01",
    "automation_task_id": "task_01",
    "automation_task_version": 1,
    "trigger_type": "manual",
    "trigger_config_snapshot": {
      "mode": "cron"
    },
    "status": "running",
    "created_at": "2026-08-18T04:00:00Z",
    "updated_at": "2026-08-18T04:00:00Z"
  }
}

The response fields are as follows.

Field

Type

Description

code

integer

0 on success.

data.id

string

Run, workspace, and automation task identifiers.

data.workspace_id

string

Run, workspace, and automation task identifiers.

data.automation_task_id

string

Run, workspace, and automation task identifiers.

data.automation_task_version

integer

The task version used to create this runtime.

data.trigger_type

string

This trigger type and trigger configuration snapshot.

data.trigger_config_snapshot

object

This trigger type and trigger configuration snapshot.

data.status

string

Running status.

data.final_text

string

The generated final text, structured output, and product reference; not returned if not generated.

data.structured_output

object

The generated final text, structured output, and product reference; not returned if not generated.

data.artifact_refs

array

The generated final text, structured output, and product references; not returned if not generated.

data.error

object

Failure details; can be returned when the operation fails.

data.started_at

string

Running time point, using RFC 3339 format; fields that have not reached the corresponding stage will not be returned.

data.completed_at

string

Running time point, using RFC 3339 format; fields that have not reached the corresponding stage will not be returned.

data.created_at

string

Running time point, using RFC 3339 format; fields that have not reached the corresponding stage will not be returned.

data.updated_at

string

Running time point, using RFC 3339 format; fields that have not reached the corresponding stage will not be returned.

Error response

JSON
{
  "code": 3,
  "message": "<错误信息>"
}

Common HTTP errors

HTTP status code

error code

Common causes

Recommended actions

400

2(INVALID_ARGUMENT)

The path parameter is invalid.

Check workspace and run ID.

401

6(UNAUTHENTICATED)

Lack of valid identity credentials.

Check API Key.

404

3(NOT_FOUND)

The running record does not exist.

Query the running list first.

503

15(UNAVAILABLE)

The automated task service is unavailable.

Try again later.

Follow-up operations

After the operation enters the final state, Query the results of automated task execution; when process information is needed, Query automation task running events.

Last updated on