Query the agent workflow binding details

Query the binding configuration of a workflow node and an agent task template.

HTTP
GET $CLOUDSIGMA_API_BASE/workspaces/{workspace_id}/agent-workflow-bindings/{binding_id}

Before you call this API

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

Set the operation-specific values used in the request:

  • $BINDING_ID: Binding ID obtained from binding list.

Request

Shell
curl "$CLOUDSIGMA_API_BASE/workspaces/$WORKSPACE_ID/agent-workflow-bindings/$BINDING_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

The target workspace ID.

binding_id

string

Yes

The binding ID to query.

Successful response

Returns 200 and binding configuration on success.

JSON
{"code": 0, "data": {"id": "binding_01", "workflow_id": "wf_01", "node_id": "node_01", "agent_task_template_id": "template_01", "input_mapping": {}}}

The response fields are as follows.

Field

Type

Description

code

integer

0 on success.

data.id

string

Binding ID.

data.workflow_id

string

Workflow ID.

data.node_id

string

Node ID.

data.agent_task_template_id

string

Association template ID.

data.input_mapping

object

Mapping of workflow input to template input.

Error response

JSON
{"code": 5, "message": "agent workflow binding not found"}

Common HTTP errors

HTTP status code

error code

Common causes

Recommended actions

404

5

The binding does not exist.

Check binding ID and workspace.
Last updated on