Referenz
REST-API
Kompiliere Lebensläufe als PDF und lies dein Konto aus eigenem Code, mit einem persönlichen API-Token.
Authentifizierung
Erstelle auf deiner Kontoseite ein persönliches API-Token, wähle seine Scopes und sende es als Bearer-Token. Prüfen lässt es sich mit /v1/auth/me:
curl https://app.doxai.ch/v1/auth/me \
-H "Authorization: Bearer $DOXAI_TOKEN"Token-Scopes
| Scope | Gibt Zugriff auf |
|---|---|
resume:generate | Vorlagen und PDF-Kompilieraufträge (/v1/resume/*). |
mcp:connect | Den MCP-Endpunkt, für Clients ohne OAuth (/v1/mcp*). |
chat:run | Modellliste und ältere Abrechnungsansichten (/v1/models, /v1/billing/*). |
tools:invoke | Nur seine Scope-Prüfung (/v1/auth/check/tools). |
Endpunkte
| Methode | Pfad | Scope | Zweck |
|---|---|---|---|
| GET | /v1/auth/me | beliebig | Benutzer und Scopes des Tokens. |
| GET | /v1/resume/templates | resume:generate | Vorlagen, Farben, Schriften, Größen. Optional locale=en|fr|de. |
| POST | /v1/resume/jobs | resume:generate | Erstellt einen PDF-Kompilierauftrag. Braucht request_id. |
| GET | /v1/resume/jobs/:jobId | resume:generate | Auftragsstatus in job.status. |
| GET | /v1/resume/jobs/:jobId/pdf | resume:generate | Lädt das PDF herunter. |
| POST | /v1/mcp | mcp:connect | MCP über Streamable HTTP. |
| GET | /v1/mcp | mcp:connect | SSE-Stream einer MCP-Sitzung (MCP-Session-Id). |
| DELETE | /v1/mcp | mcp:connect | Schließt eine MCP-Sitzung. |
| GET | /v1/mcp/tools | mcp:connect | Listet die Tools, als einfaches REST. |
| POST | /v1/mcp/tools/call | mcp:connect | Ruft ein Tool auf, als einfaches REST. |
| GET | /v1/models | chat:run | Modelle mit Zugriff pro Benutzer. |
| GET | /v1/billing/status | chat:run | Älterer Abrechnungsstatus des Chats. |
| GET | /v1/billing/usage | chat:run | Ältere Chat-Nutzung. Optional from, to, limit. |
| GET | /v1/auth/check/:scope | Scope im Pfad | Scope-Prüfungen: chat, resume, tools, mcp; jede braucht ihren Scope. |
| GET | /healthz | öffentlich | Erreichbarkeit. |
| GET | /openapi.json | öffentlich | Diese API als OpenAPI (auch /v1/openapi.json). |
Die verwalteten Chat-Endpunkte /v1/chat/completions und /v1/responses sind eingestellt und antworten mit 410 managed_chat_removed. Der ältere SSE-Transport (/v1/mcp/sse, /v1/mcp/messages) bleibt für ältere Clients.
Einen Lebenslauf kompilieren
Sende einen JSON-Body mit request_id und cv_data (hier in job.json). Das Kompilieren ist in jedem Tarif kostenlos.
curl -X POST https://app.doxai.ch/v1/resume/jobs \
-H "Authorization: Bearer $DOXAI_TOKEN" \
-H "Content-Type: application/json" \
-d @job.jsonFrage danach GET /v1/resume/jobs/:jobId ab, bis job.status den Wert succeeded (oder failed) hat, und lade /pdf herunter.
Die Form von cv_data steht im OpenAPI-Dokument; alternativ helfen die Connector-Tools resume_get_create_job_example und resume_validate_cv_data.
Gemeinsame Header
| Header | Verwendung |
|---|---|
Authorization | Bearer <token> bei jedem authentifizierten Aufruf. |
x-request-id | Optional, wird zur Log-Zuordnung zurückgegeben. |
MCP-Session-Id | MCP-Aufrufe nach initialize. |
x-ai-mode | Optional auf /v1/models: managed, api oder mcp (Standard api). |
Ältere Tier-Felder
/v1/models und /v1/billing/* liefern weiterhin tier (free, credits, subscription), tier_label (free, flex, pro) und model.access (all, paid, subscription). Diese Felder gehören zu den älteren Chat-Abrechnungsansichten und bezeichnen nicht die DoxAI-Tarife Kostenlos, Plus und Pro: Den Tarif liefert account_get_billing_status.
OpenAPI
Der vollständige Vertrag mit Anfrage- und Antwortschemas: