API overview

Run agents over HTTP with streaming and webhooks.

The API exposes the same run model over HTTP. Use it to embed agents in services, trigger runs from CI, or build custom frontends.

Base URL

https://api.optamus.cloud/v1

Authentication

All requests require a bearer token:

curl -H "Authorization: Bearer $OPTAMUS_API_KEY" \
  https://api.optamus.cloud/v1/runs

Core resources

Runs — one unit of agent work; create, stream, and fetch results
Workspaces — server-side folders the agent can access
Keys — scoped API credentials

Streaming

Runs stream progress as Server-Sent Events:

curl -N -H "Authorization: Bearer $OPTAMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"List open PRs","workspace":"ws_123"}' \
  https://api.optamus.cloud/v1/runs

Next: Authentication in depth.