Skip to main content
POST
Create a run

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