Update agent workflow binding¶
Update a bound workflow, node, template, or input-output mapping.
PATCH https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/agent-workflow-bindings/{binding_id}
Before you call¶
The example below uses:
$AI_STUDIO_API_KEY: Actual personal access token.$WORKSPACE_ID: Target workspace ID.$BINDING_ID: Binding ID to update.
Request example¶
curl -X PATCH "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/agent-workflow-bindings/$BINDING_ID" -H "X-API-Key: $AI_STUDIO_API_KEY" -H "X-Workspace-ID: $WORKSPACE_ID" -H 'Content-Type: application/json' -d '{"input_mapping":{"document":"$.content"}}'
Request body¶
Parameters |
Type |
Is it required |
Description |
|---|---|---|---|
|
string |
No |
Workflow ID. |
|
string |
No |
Workflow version ID. |
|
string |
No |
Workflow node ID. |
|
string |
No |
Agent task template ID. |
|
object |
No |
Input mapping. |
|
object |
No |
Output mapping. |
|
object |
No |
Failure handling mapping. |
|
string |
No |
Binding status. |
|
object |
No |
Tag key-value pair. |
|
object |
No |
Annotation key-value pair. |
Successful response¶
Returns 200 and the updated binding on success.
{"code": 0, "data": {"id": "binding_01", "input_mapping": {"document": "$.content"}}}
The response fields are as follows.
Field |
Type |
Description |
|---|---|---|
|
integer |
|
|
string |
Binding ID. |
|
object |
The updated input map. |
Error response¶
{"code": 5, "message": "agent workflow binding not found"}
Common HTTP errors¶
HTTP status code |
error code |
Common causes |
Recommended actions |
|---|---|---|---|
|
|
The request body is invalid. |
Check the fields to be updated. |
|
|
The binding does not exist. |
Check the binding ID. |