Skip to main content
cURL
curl --request POST \
  --url https://api.simplex.sh/run_agent \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "agent_name": "<string>",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "variables": {
    "key1": "value1",
    "key2": "value2"
  }
}'
{
  "succeeded": true,
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_name": "<string>",
  "result": {}
}
Run a pre-built agent that has been defined in the Simplex dashboard.

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Body

application/json
​
agent_name
string
required

The name of the agent to run.

​
session_id
string<uuid>
required

Session ID to use for the agent run.

​
variables
object

JSON object containing variables to pass to the agent.

Example:
{ "key1": "value1", "key2": "value2" }

Response

Run agent response

​
succeeded
boolean
required

Whether the agent ran successfully.

​
agent_name
string
required

The name of the agent that was run.

​
session_id
string<uuid>

The session ID for the agent run.

​
result
object

The result of the agent run.