Skip to content
Codexa

Developers

API, SDK, CLI, and webhooks for building on Codexa.

On this page

Codexa is built on an ordinary HTTP API, and the same API is available to you. This page is the map; the pages in the sidebar have the details.

What exists today

  • HTTP API at /api/v1/* (authentication under /api/auth/*). Every call the product makes is a call you can make. The reference lists 81 implemented endpoints, checked against the server's route files when this page renders.
  • Authentication by session cookie. Sign in with POST /api/auth/login and send the cookie on subsequent requests. Personal API tokens are planned and not available yet; see API authentication.
  • Streaming for AI runs and runtime logs over server-sent events. See Generations.
  • Inbound webhooks from Stripe and Razorpay with signature verification and idempotency. See Webhooks. Outbound webhooks (Codexa calling your URL) do not exist yet.

What does not exist yet

ItemStatus
API tokensPlanned; the API accepts only the session cookie today
SDKNot yet available; see /sdk
CLINot yet available; see /cli
Outbound webhooksNot planned for the initial releases
OpenAPI specNot published; the reference page is generated from a registry in the codebase

Conventions

  • JSON in, JSON out. Bodies are validated; errors come back as { "error": { "code", "message", "details?" } }.
  • Resources are scoped to a workspace. Every request is authorised server-side against your role in that workspace.
  • Rate limits return 429 with Retry-After.
  • Quota limits return 402 with quota_exceeded.

Try it

# Sign in and keep the cookie
curl -c cookies.txt -X POST https://<your-codexa-host>/api/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"email":"you@example.com","password":"…"}'

# List your workspaces
curl -b cookies.txt https://<your-codexa-host>/api/v1/workspaces