Référence
API REST
Compilez des CV en PDF et lisez votre compte depuis votre code, avec un token API personnel.
Authentification
Créez un token API personnel sur la page de votre compte, choisissez ses scopes et envoyez-le comme Bearer token. Vérifiez-le avec /v1/auth/me :
curl https://app.doxai.ch/v1/auth/me \
-H "Authorization: Bearer $DOXAI_TOKEN"Scopes des tokens
| Scope | Donne accès à |
|---|---|
resume:generate | Modèles et compilations PDF (/v1/resume/*). |
mcp:connect | L’endpoint MCP, pour les clients sans OAuth (/v1/mcp*). |
chat:run | Liste des modèles et anciennes vues de facturation (/v1/models, /v1/billing/*). |
tools:invoke | Sa vérification de scope seulement (/v1/auth/check/tools). |
Endpoints
| Méthode | Chemin | Scope | Rôle |
|---|---|---|---|
| GET | /v1/auth/me | tous | L’utilisateur et les scopes du token. |
| GET | /v1/resume/templates | resume:generate | Modèles, couleurs, polices, tailles. locale=en|fr|de facultatif. |
| POST | /v1/resume/jobs | resume:generate | Crée une compilation PDF. Demande request_id. |
| GET | /v1/resume/jobs/:jobId | resume:generate | État de la compilation dans job.status. |
| GET | /v1/resume/jobs/:jobId/pdf | resume:generate | Télécharge le PDF. |
| POST | /v1/mcp | mcp:connect | MCP en HTTP streamable. |
| GET | /v1/mcp | mcp:connect | Flux SSE d’une session MCP (MCP-Session-Id). |
| DELETE | /v1/mcp | mcp:connect | Ferme une session MCP. |
| GET | /v1/mcp/tools | mcp:connect | Liste les outils, en REST simple. |
| POST | /v1/mcp/tools/call | mcp:connect | Appelle un outil, en REST simple. |
| GET | /v1/models | chat:run | Modèles et accès par utilisateur. |
| GET | /v1/billing/status | chat:run | Ancien état de facturation du chat. |
| GET | /v1/billing/usage | chat:run | Ancien relevé d’usage du chat. from, to, limit facultatifs. |
| GET | /v1/auth/check/:scope | scope du chemin | Vérification de scope : chat, resume, tools, mcp ; chacune demande son scope. |
| GET | /healthz | public | Disponibilité. |
| GET | /openapi.json | public | Cette API au format OpenAPI (aussi /v1/openapi.json). |
Les endpoints de chat managé /v1/chat/completions et /v1/responses sont retirés et répondent 410 managed_chat_removed. L’ancien transport SSE (/v1/mcp/sse, /v1/mcp/messages) reste pour les anciens clients.
Compiler un CV
Envoyez un corps JSON avec request_id et cv_data (ici dans job.json). La compilation est gratuite avec toutes les offres.
curl -X POST https://app.doxai.ch/v1/resume/jobs \
-H "Authorization: Bearer $DOXAI_TOKEN" \
-H "Content-Type: application/json" \
-d @job.jsonInterrogez ensuite GET /v1/resume/jobs/:jobId jusqu’à ce que job.status vaille succeeded (ou failed), puis téléchargez /pdf.
Pour la forme de cv_data, lisez le document OpenAPI, ou appelez les outils du connecteur resume_get_create_job_example et resume_validate_cv_data.
En-têtes communs
| En-tête | Usage |
|---|---|
Authorization | Bearer <token> sur chaque appel authentifié. |
x-request-id | Facultatif, renvoyé pour relier les logs. |
MCP-Session-Id | Appels MCP après initialize. |
x-ai-mode | Facultatif sur /v1/models : managed, api ou mcp (défaut api). |
Anciens champs de tier
/v1/models et /v1/billing/* renvoient encore tier (free, credits, subscription), tier_label (free, flex, pro) et model.access (all, paid, subscription). Ces champs relèvent des anciennes vues de facturation du chat et ne désignent pas les offres DoxAI, qui sont Gratuit, Plus et Pro : lisez l’offre avec account_get_billing_status.
OpenAPI
Le contrat complet, avec les schémas de requête et de réponse :