API reference
API reference
Every v1 endpoint with parameters, request body, response shape, and example. Renders the canonical OpenAPI 3.1 spec.
Last updated
The complete v1 surface is documented in OpenAPI 3.1 form at /api/v1/openapi.json. That document is the source of truth — this page summarizes it and links to the rendered view.
OpenAPI 3.1 spec
The spec is hand-curated (not auto-generated from zod schemas) and kept honest by scripts/check-openapi-drift.mjs — a CI invariant that fails the build if a route file lands without a matching paths entry.
- JSON: /api/v1/openapi.json
- Cached at the edge for 1 hour; stale-while-revalidate 24h.
- Public; CORS open to all origins (for code-gen tools).
Rendered reference
For interactive browsing, point any of these tools at /api/v1/openapi.json:
An embedded interactive reference is on the Tier 7 follow-up backlog — once it lands, this page becomes the rendered reference directly. For now, the OpenAPI doc itself is the canonical reference.
Endpoint groups
Six tags carve the surface:
- Discovery — public read endpoints for live events and jobs. No token required.
- Profile— read/write the authenticated user's profile, queue, matches, interview lifecycle.
- Billing — plan, invoices, checkout, portal, off-session charges.
- Recruiter — recruiter admin: events, jobs, team invites, candidate management, AI compare.
- Settings — generic settings registry; discover paths and read/write values.
- Webhooks — subscribe to events for external integrations.
Code generation
The spec is designed for code generation. Recommended tools:
- TypeScript: openapi-typescript-codegen or openapi-typescript.
- Python: openapi-python-client.
- Go: oapi-codegen.
We also publish hand-written SDKs for JavaScript / TypeScript and Python.