API reference
Every request your server can send to https://api.phoenix.so, and the one Rush sends back to you. Generated from the OpenAPI document the API is checked against; download it as openapi.json.
Sessions
Start, list, read and steer sessions. A session is one agent run in its own sandbox.
/o/{org}/sessionsPOSTStart a session/o/{org}/sessionsGETGet one session/o/{org}/sessions/{session}POSTCancel a session/o/{org}/sessions/{session}/cancelPOSTStart a session (console, by Project)/o/{org}/p/{project}/sessionsGETList the turns of a session/o/{org}/p/{project}/sessions/{session}/turnsGETGet one turn/o/{org}/p/{project}/sessions/{session}/turns/{turn}Events
Follow a session live over server-sent events, or read its log.
Messages
Read a session's transcript and tool calls, and send it follow-ups.
Results & artifacts
The answer, changed files, captured transcript and files a session produced.
Secrets
Values a session uses without them appearing in a response. Every secret belongs to one Project and reaches every session in it.
/o/{org}/secretsPOSTSave a secret. The value is sealed and never returned./o/{org}/secretsPATCHReplace a secret's value or note, or a sign-in's site./o/{org}/secrets/{secret}DELETEDelete a secret. A session that names it afterwards fails instead of starting without it./o/{org}/secrets/{secret}API keys
API keys for server-to-server calls, and the webhook each key delivers to.
Agents & models
The harnesses, models, apps and MCP servers an org can run.
Webhooks
Requests Rush sends to your server.
Projects
Projects tie a repository to its runs and connectors.
Billing
The caller's plan, usage, spend limit and Stripe sessions.
GitHub
The GitHub App installations and repositories runs can use.
Saved agents
Reusable agent setups (harness, model, tools and connections), revisioned.
/o/{org}/agentsPOSTSave an agent./o/{org}/agentsGETGet a saved agent you can use./o/{org}/agents/{agent}PATCHEdit a saved agent./o/{org}/agents/{agent}DELETEDelete a saved agent./o/{org}/agents/{agent}GETList the accounts and MCP servers connected to one agent made from a template./o/{org}/agents/{agent}/connectionsPOSTStart a sign-in that connects an account or MCP server to one agent./o/{org}/agents/{agent}/connectionsGETRead one of an agent's connections, or the sign-in that makes it./o/{org}/agents/{agent}/connections/{connection}DELETEDisconnect one of an agent's connections, or cancel its sign-in./o/{org}/agents/{agent}/connections/{connection}GETRead one agent listed in Community/o/{org}/agents/community/{agent}GETList the agents companies listed in Community/o/{org}/agents/communityGETRead one Community agent, with no credential/community/agents/{agent}GETList Community agents, with no credential/community/agentsAttachments
Files uploaded to attach to a run.
Devices
Your own computers, which a run you start can use with your approval.
Session lifecycle
A session's status moves left to right. The stream's status events and GET on the session report it; a turn's end also reaches your webhook.
running.Authentication
Send Authorization: Bearer <token> on every request. The session routes take an API key or a signed-in session ($RUSH_API_KEY in the samples); every other route takes a signed-in session token (an API key cannot call this route) ($RUSH_TOKEN, a person's signed-in console session). A missing, revoked or expired token is 401. Another org's resource answers 404, the same as one that does not exist.
| Scheme | What it is |
|---|---|
bearerAuth | An API key ( |
Errors
Every error is JSON with a stable code and a readable message. Every code, its status and the operations that send it.
Limits and concurrency
A key runs at most max_concurrent sessions at once (4 unless you set it when creating the key, up to 100). One more is created queued and starts, oldest first, when one of the key's slots frees (a parked sandbox holds none); it never holds up your other keys or the console.
A running session queues at most 20 follow-ups; one more answers 429 with QUEUE_FULL.
Past your account's first $1, a key's runs on Rush's models are paid from prepaid credits, and stop with 402 at $0. A spend limit set in Billing caps how much of the credits they use in a period.
Pagination
List operations return at most limit rows. When there are more, the response carries next_cursor; pass it back as cursor for the next page, until next_cursor is null. List sessions, Follow a session live, List saved agents you can use, newest first., List the agents companies listed in Community, List Community agents, with no credential page this way.
Max rows to return.
50min 1max 500Opaque pagination cursor from a previous response's next_cursor.