API
API reference
Find the real SDK exports and hosted endpoints for configuration, execution, lifecycle operations, and inspection. Hosted and direct-provider clients have different setup requirements.
- POST /api/dashboard/control-plane/workers
- GET /api/dashboard/machines
- POST /api/agents/run
- GET /api/dashboard/control-plane/operations/:id
- GET /api/dashboard/logs
- GET /api/dashboard/metrics/usage
- GET /api/dashboard/machines/:id
Choose your path
Direct SDK or hosted API?
Direct SDK
createMux selects runtime/provider adapters and returns a machine with streaming run and PTY methods. Supply your own provider SDK dependency and credentials.
Hosted client
AgentMachines creates and runs a managed agent over HTTP. Create an account API key in Settings and set the hosted base URL.
Control plane
WorkerSpec, a store, and a runtime driver support declarative lifecycle operations. Hosted memory/profile integration is not supplied by the default direct SDK driver.
Next step
Connect a client.
Direct SDK guide
Install the TypeScript SDK and supply provider dependencies and credentials.
Hosted API keys
Create or manage account keys. Hosted endpoints require authentication.
Inspect usage
Review recorded activity. Missing measurements are not a zero-cost result.
Dashboard actions require an account. Provider capabilities, credentials, and charges still apply.