DoxAI
InhaltREST-API

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"
API-Tokens verwalten

Token-Scopes

ScopeGibt Zugriff auf
resume:generateVorlagen und PDF-Kompilieraufträge (/v1/resume/*).
mcp:connectDen MCP-Endpunkt, für Clients ohne OAuth (/v1/mcp*).
chat:runModellliste und ältere Abrechnungsansichten (/v1/models, /v1/billing/*).
tools:invokeNur seine Scope-Prüfung (/v1/auth/check/tools).

Endpunkte

MethodePfadScopeZweck
GET/v1/auth/mebeliebigBenutzer und Scopes des Tokens.
GET/v1/resume/templatesresume:generateVorlagen, Farben, Schriften, Größen. Optional locale=en|fr|de.
POST/v1/resume/jobsresume:generateErstellt einen PDF-Kompilierauftrag. Braucht request_id.
GET/v1/resume/jobs/:jobIdresume:generateAuftragsstatus in job.status.
GET/v1/resume/jobs/:jobId/pdfresume:generateLädt das PDF herunter.
POST/v1/mcpmcp:connectMCP über Streamable HTTP.
GET/v1/mcpmcp:connectSSE-Stream einer MCP-Sitzung (MCP-Session-Id).
DELETE/v1/mcpmcp:connectSchließt eine MCP-Sitzung.
GET/v1/mcp/toolsmcp:connectListet die Tools, als einfaches REST.
POST/v1/mcp/tools/callmcp:connectRuft ein Tool auf, als einfaches REST.
GET/v1/modelschat:runModelle mit Zugriff pro Benutzer.
GET/v1/billing/statuschat:runÄlterer Abrechnungsstatus des Chats.
GET/v1/billing/usagechat:runÄltere Chat-Nutzung. Optional from, to, limit.
GET/v1/auth/check/:scopeScope im PfadScope-Prüfungen: chat, resume, tools, mcp; jede braucht ihren Scope.
GET/healthzöffentlichErreichbarkeit.
GET/openapi.jsonöffentlichDiese 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.json

Frage 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

HeaderVerwendung
AuthorizationBearer <token> bei jedem authentifizierten Aufruf.
x-request-idOptional, wird zur Log-Zuordnung zurückgegeben.
MCP-Session-IdMCP-Aufrufe nach initialize.
x-ai-modeOptional 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: