Skip to main content

​
Base URL

https://api.usezombie.com

​
Authentication

All API endpoints require a Bearer token in the Authorization header, except health checks and the initial auth session creation. 
curl https://api.usezombie.com/v1/runs \
  -H "Authorization: Bearer $ZOMBIE_TOKEN"
Obtain a token via the CLI login flow (zombiectl login) or by creating an auth session programmatically:
  1. POST /v1/auth/sessions — returns a login_url and session_id
  2. Complete the OAuth flow in the browser
  3. GET /v1/auth/sessions/{session_id} — poll until status: "complete", then extract the token

​
Errors

All errors follow a consistent format: 
{
  "error": {
    "code": "WORKSPACE_NOT_FOUND",
    "message": "No workspace with the given ID exists."
  },
  "request_id": "req_01JQ7K..."
}
Every response includes a request_id for tracing.

​
Conventions

  • IDs are UUIDs.
  • Timestamps are Unix milliseconds.
  • Action endpoints use :action suffix (e.g., /v1/runs/{run_id}:cancel).
  • Streaming endpoints (replay, stream, agent relay) return Server-Sent Events.

​
Rate limits

API rate limits are per-workspace. If you hit a rate limit, the response includes a Retry-After header.

OpenAPI Spec

View the full OpenAPI 3.1 specification