Base URL
All endpoints are rooted at:Authentication
Send your API key in theAuthorization header on every request:
Core resources
Agents
Hosted agent definitions with a stable URL and version history.
Sessions
Durable conversations or tasks pinned to the agent version active at creation time.
Messages
Per-turn inputs and outputs for a session.
Files
Uploaded assets and session workspace files.
Choose a message mode
All three message endpoints create a message record under the same session. They differ only in how the HTTP request returns:async: returns after the message is accepted and queuedsync: waits for a terminal message resultstream: returns incremental output over the same request
Common flow
- Create or publish an agent.
- Create a session from that agent.
- Upload any files you want to reference in a message.
- Send a message to the session.
- Poll the session or inspect the session filesystem as needed.