get_workflow
Full detail for one workflow, including input and output schema.
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_id | string | yes | Workflow id (agent_…) |
Returns#
json
{
"id": "agent_abc",
"name": "Enrich Contact",
"description": "Takes an email; returns company + role + seniority.",
"input_schema": {
"type": "object",
"properties": { "email": { "type": "string" } },
"required": ["email"]
},
"output_schema": {
"type": "object",
"properties": {
"company": { "type": "string" },
"role": { "type": "string" },
"seniority": { "type": "string" }
}
},
"created_at": "2026-03-01T00:00:00Z",
"updated_at": "2026-04-20T12:00:00Z"
}output_schema is derived from the trigger node’s declared output variables; it may be null if the workflow doesn’t declare outputs.
Errors#
error_type | When |
|---|---|
auth_error | Missing / invalid API key |
not_found | Workflow id doesn’t exist or is outside your org |
Example#
Request: { "workflow_id": "agent_abc" }
Response: as shown above.
See also#
list_workflows— discover workflow idsrun_workflow— invoke with a matching input