Skip to main content
POST
/
agents
/
{agent_id}
/
runs
Create a run
curl --request POST \
  --url https://api.push.ai/api/v1/agents/{agent_id}/runs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "parameter_bindings": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.push.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Organization API key. Create one in the Push AI dashboard under Settings → API Keys.

Path Parameters

​
agent_id
integer
required

The ID of the agent to invoke.

Query Parameters

​
dry_run
boolean
default:false

If true, returns the compiled prompt and parameters without executing the agent.

Body

application/json
​
parameter_bindings
object[] | null

Optional parameter values to bind for this run. Each entry maps a parameter name to a value.

Response

Run accepted and queued for execution.

​
run_id
string<uuid>
required

Unique run identifier. Use this to poll for status.

​
status
enum<string>
required

Initial status of the queued run.

Available options:
pending