DoxAI
ContentsREST API

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"
Manage API tokens

Token scopes

ScopeGives access to
resume:generateTemplates and PDF compile jobs (/v1/resume/*).
mcp:connectThe MCP endpoint, for clients without OAuth (/v1/mcp*).
chat:runModel list and legacy billing views (/v1/models, /v1/billing/*).
tools:invokeIts scope probe only (/v1/auth/check/tools).

Endpoints

MethodPathScopeDoes
GET/v1/auth/meanyThe token’s user and scopes.
GET/v1/resume/templatesresume:generateTemplates, colours, fonts, sizes. Optional locale=en|fr|de.
POST/v1/resume/jobsresume:generateCreate a PDF compile job. Needs request_id.
GET/v1/resume/jobs/:jobIdresume:generateJob status in job.status.
GET/v1/resume/jobs/:jobId/pdfresume:generateDownload the PDF.
POST/v1/mcpmcp:connectMCP over streamable HTTP.
GET/v1/mcpmcp:connectSSE stream of an MCP session (MCP-Session-Id).
DELETE/v1/mcpmcp:connectClose an MCP session.
GET/v1/mcp/toolsmcp:connectList tools, as plain REST.
POST/v1/mcp/tools/callmcp:connectCall a tool, as plain REST.
GET/v1/modelschat:runModels with per-user access.
GET/v1/billing/statuschat:runLegacy chat billing status.
GET/v1/billing/usagechat:runLegacy chat usage. Optional from, to, limit.
GET/v1/auth/check/:scopescope in pathScope probes: chat, resume, tools, mcp; each needs its scope.
GET/healthzpublicLiveness.
GET/openapi.jsonpublicThis 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.json

Then 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

HeaderUse
AuthorizationBearer <token> on every authenticated call.
x-request-idOptional, echoed back to correlate logs.
MCP-Session-IdMCP calls after initialize.
x-ai-modeOptional 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: