Skip to main content
POST
/
v1
/
workflows
/
{workflow_id}
/
invoke
Invoke Workflow (Sync)
curl --request POST \
  --url https://api.xpander.ai/v1/workflows/{workflow_id}/invoke \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "input": {
    "text": "",
    "files": [],
    "user": {
      "email": "<string>",
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "additional_attributes": {},
      "role": "member",
      "is_super_admin": false,
      "timezone": "<string>"
    }
  },
  "id": "<string>",
  "payload_extension": {},
  "parent_execution_id": "<string>",
  "worker_id": "<string>",
  "source": "<string>",
  "output_schema": {},
  "run_locally": false,
  "additional_context": "<string>",
  "instructions_override": "<string>",
  "test_run_node_id": "<string>",
  "expected_output": "<string>",
  "events_streaming": false,
  "mcp_servers": [],
  "triggering_agent_id": "<string>",
  "title": "<string>",
  "think_mode": "default",
  "disable_attachment_injection": false,
  "user_tokens": {},
  "user_oidc_token": "<string>",
  "return_metrics": false,
  "llm_model_provider": "<string>",
  "llm_model_name": "<string>"
}
'
{
  "id": "<string>",
  "agent_id": "<string>",
  "organization_id": "<string>",
  "input": {
    "text": "",
    "files": [],
    "user": {
      "email": "<string>",
      "display_name": "<string>",
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "additional_attributes": {},
      "role": "member",
      "is_super_admin": false,
      "timezone": "<string>"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "status": "pending",
  "internal_status": "<string>",
  "last_executed_node_id": "<string>",
  "agent_version": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "paused_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "result": "<string>",
  "parent_execution": "<string>",
  "sub_executions": [],
  "finished_sub_executions": [],
  "should_update_parent": false,
  "is_manually_stopped": false,
  "is_background": false,
  "payload_extension": {},
  "hitl_request": {
    "wait_node_id": "<string>"
  },
  "pending_eca_request": {
    "connector_name": "<string>",
    "auth_url": "<string>"
  },
  "source": "<string>",
  "worker_id": "<string>",
  "additional_context": "<string>",
  "instructions_override": "<string>",
  "expected_output": "<string>",
  "test_run_node_id": "<string>",
  "is_orchestration": false,
  "is_gateway": false,
  "output_format": "text",
  "voice_id": "<string>",
  "output_schema": {},
  "events_streaming": false,
  "used_mutating_tools": false,
  "is_continuous": false,
  "mcp_servers": [],
  "triggering_agent_id": "<string>",
  "title": "<string>",
  "think_mode": "default",
  "disable_attachment_injection": false,
  "deep_planning": {
    "enabled": false,
    "enforce": false,
    "started": false,
    "question_raised": false,
    "tasks": []
  },
  "execution_attempts": 1,
  "user_tokens": {},
  "user_oidc_token": "<string>",
  "return_metrics": false,
  "tokens": {
    "completion_tokens": 0,
    "prompt_tokens": 0,
    "total_tokens": 0
  },
  "llm_model_provider": "<string>",
  "llm_model_name": "<string>"
}
Invoke a workflow synchronously. The request blocks until the entire pipeline completes — data flows through each node on the canvas from START to END, and the final result is returned. For longer-running workflows, use Invoke Workflow (Async) or Invoke Workflow (Stream) to track progress in real time.

​
Path Parameters

​
workflow_id
string
required
Workflow ID (UUID)

​
Query Parameters

​
version
string
The workflow version to invoke. Defaults to the latest deployed version.

​
Request Body

​
input
object
required
​
id
string
Thread ID for multi-turn conversations. Pass the id from a previous task’s response to continue the same conversation.
​
think_mode
string
default:"default"
Controls reasoning depth: default or harder
​
instructions_override
string
Additional instructions for this invocation only
​
expected_output
string
Natural-language description of the desired output

​
Response

​
id
string
Task/thread ID — pass this back to continue the conversation
​
status
string
completed, failed, error, or stopped
​
result
string
The workflow’s final response

​
Example Request

curl -X POST "https://api.xpander.ai/v1/workflows/<workflow-id>/invoke" \
  -H "Content-Type: application/json" \
  -H "x-api-key: <your-api-key>" \
  -d '{"input": {"text": "Process this customer onboarding request"}}'

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
workflow_id
string
required

Query Parameters

​
version
string | null

The workflow version to invoke. default = latest

Body

application/json
​
input
AgentExecutionInput · object
required
​
id
string | null
​
payload_extension
Payload Extension · object
​
parent_execution_id
string | null
​
worker_id
string | null
​
source
string | null
​
output_format
enum<string> | null
Available options:
text,
markdown,
json,
voice
​
output_schema
Output Schema · object
​
run_locally
boolean | null
default:false
​
additional_context
string | null
​
instructions_override
string | null
​
test_run_node_id
string | null
​
expected_output
string | null
​
events_streaming
boolean | null
default:false
​
mcp_servers
Mcp Servers · object[] | null
​
triggering_agent_id
string | null
​
title
string | null
​
think_mode
enum<string> | null
default:default
Available options:
default,
harder
​
disable_attachment_injection
boolean | null
default:false
​
user_tokens
User Tokens · object
​
user_oidc_token
string | null
​
return_metrics
boolean | null
default:false
​
llm_model_provider
string | null

Per-execution override for the LLM provider (e.g. 'openai', 'anthropic'). Falls back to the agent's configured provider when unset.

​
llm_model_name
string | null

Per-execution override for the LLM model name. Falls back to the agent's configured model when unset.

​
llm_reasoning_effort
enum<string> | null

Per-execution override for reasoning effort on reasoning-capable models.

Available options:
low,
medium,
high,
xhigh
​
source_node_type
enum<string> | null

Surface that created this execution (mirrored to AgentExecutionHistory.source_node_type). Falls back to SourceNodeType.SDK at persist time when unset.

Available options:
workbench,
sdk,
task,
assistant,
webhook,
mcp,
a2a,
telegram,
slack

Response

Successful Response

Task creation response model.

Extends AgentExecution with additional agent_id field.

​
id
string
required
​
agent_id
string
required
​
organization_id
string
required
​
input
AgentExecutionInput · object
required
​
created_at
string<date-time>
required
​
status
enum<string> | null
default:pending
Available options:
pending,
executing,
paused,
error,
failed,
completed,
stopped
​
internal_status
string | null
​
last_executed_node_id
string | null
​
agent_version
string | null
​
started_at
string<date-time> | null
​
paused_at
string<date-time> | null
​
finished_at
string<date-time> | null
​
result
string | null
​
parent_execution
string | null
​
sub_executions
string[] | null
​
finished_sub_executions
string[] | null
​
should_update_parent
boolean | null
default:false
​
is_manually_stopped
boolean | null
default:false
​
is_background
boolean | null
default:false
​
payload_extension
Payload Extension · object
​
hitl_request
HumanInTheLoopRequest · object

Model representing human-in-the-loop approval records for tasks.

Attributes: wait_node_id (str): The id of the node that triggered this HITL.

​
pending_eca_request
PendingECARequest · object
​
source
string | null
​
worker_id
string | null
​
additional_context
string | null
​
instructions_override
string | null
​
expected_output
string | null
​
test_run_node_id
string | null
​
is_orchestration
boolean | null
default:false
​
is_gateway
boolean | null
default:false
​
output_format
enum<string> | null
default:text
Available options:
text,
markdown,
json,
voice
​
voice_id
string | null
​
output_schema
Output Schema · object
​
events_streaming
boolean | null
default:false
​
used_mutating_tools
boolean | null
default:false
​
is_continuous
boolean | null
default:false
​
mcp_servers
Mcp Servers · object[] | null
​
triggering_agent_id
string | null
​
title
string | null
​
think_mode
enum<string> | null
default:default
Available options:
default,
harder
​
disable_attachment_injection
boolean | null
default:false
​
deep_planning
DeepPlanning · object
​
execution_attempts
integer | null
default:1
​
user_tokens
User Tokens · object
​
user_oidc_token
string | null
​
return_metrics
boolean | null
default:false
​
tokens
LLMTokens · object
​
llm_model_provider
string | null

Snapshot of the LLM provider used for this execution (request override or agent default at run time).

​
llm_model_name
string | null

Snapshot of the LLM model name used for this execution (request override or agent default at run time).

​
llm_reasoning_effort
enum<string> | null

Snapshot of the reasoning effort applied during this execution, when supported by the model.

Available options:
low,
medium,
high,
xhigh