Reference
REST API
Compile CVs to PDF and read your account from your own code, with a personal API token.
Authentication
Create a personal API token on your account page, pick its scopes, and send it as a Bearer token. Check it with /v1/auth/me:
curl https://app.doxai.ch/v1/auth/me \
-H "Authorization: Bearer $DOXAI_TOKEN"Token scopes
| Scope | Gives access to |
|---|---|
resume:generate | Templates and PDF compile jobs (/v1/resume/*). |
mcp:connect | The MCP endpoint, for clients without OAuth (/v1/mcp*). |
chat:run | Model list and legacy billing views (/v1/models, /v1/billing/*). |
tools:invoke | Its scope probe only (/v1/auth/check/tools). |
Endpoints
| Method | Path | Scope | Does |
|---|---|---|---|
| GET | /v1/auth/me | any | The token’s user and scopes. |
| GET | /v1/resume/templates | resume:generate | Templates, colours, fonts, sizes. Optional locale=en|fr|de. |
| POST | /v1/resume/jobs | resume:generate | Create a PDF compile job. Needs request_id. |
| GET | /v1/resume/jobs/:jobId | resume:generate | Job status in job.status. |
| GET | /v1/resume/jobs/:jobId/pdf | resume:generate | Download the PDF. |
| POST | /v1/mcp | mcp:connect | MCP over streamable HTTP. |
| GET | /v1/mcp | mcp:connect | SSE stream of an MCP session (MCP-Session-Id). |
| DELETE | /v1/mcp | mcp:connect | Close an MCP session. |
| GET | /v1/mcp/tools | mcp:connect | List tools, as plain REST. |
| POST | /v1/mcp/tools/call | mcp:connect | Call a tool, as plain REST. |
| GET | /v1/models | chat:run | Models with per-user access. |
| GET | /v1/billing/status | chat:run | Legacy chat billing status. |
| GET | /v1/billing/usage | chat:run | Legacy chat usage. Optional from, to, limit. |
| GET | /v1/auth/check/:scope | scope in path | Scope probes: chat, resume, tools, mcp; each needs its scope. |
| GET | /healthz | public | Liveness. |
| GET | /openapi.json | public | This API as OpenAPI (also /v1/openapi.json). |
The managed chat endpoints /v1/chat/completions and /v1/responses are retired and answer 410 managed_chat_removed. The legacy SSE transport (/v1/mcp/sse, /v1/mcp/messages) stays for older clients.
Compile a CV
Send a JSON body with request_id and cv_data (here in job.json). Compiling is free on every plan.
curl -X POST https://app.doxai.ch/v1/resume/jobs \
-H "Authorization: Bearer $DOXAI_TOKEN" \
-H "Content-Type: application/json" \
-d @job.jsonThen poll GET /v1/resume/jobs/:jobId until job.status is succeeded (or failed), and download /pdf.
For the cv_data shape, read the OpenAPI document, or call the connector tools resume_get_create_job_example and resume_validate_cv_data.
Common headers
| Header | Use |
|---|---|
Authorization | Bearer <token> on every authenticated call. |
x-request-id | Optional, echoed back to correlate logs. |
MCP-Session-Id | MCP calls after initialize. |
x-ai-mode | Optional on /v1/models: managed, api or mcp (default api). |
Legacy tier fields
/v1/models and /v1/billing/* still return tier (free, credits, subscription), tier_label (free, flex, pro) and model.access (all, paid, subscription). These belong to the legacy chat-billing views and are not the DoxAI plans, which are Free, Plus and Pro: read the plan with account_get_billing_status.
OpenAPI
The full contract, with request and response schemas: