OpenAPI / Swagger UI

Das KnowledgeSDK stellt eine interaktive API-Dokumentation bereit, die auf der OpenAPI 3.1 Spezifikation basiert.

Zugriff

URL	Format
/api/docs	Swagger UI (interaktiv im Browser)
/api/docs?json	OpenAPI 3.1 Spec als JSON

Authentifizierung

Die Classifier-Endpoints erfordern einen API-Key. In der Swagger UI kann der Key ueber den “Authorize”-Button (oben rechts) eingegeben werden:


Bearer <CLASSIFIER_API_KEY>

Ohne konfigurierten API-Key sind die Endpoints im Entwicklungsmodus offen zugaenglich.

Dokumentierte Endpoints

Suche

Endpoint	Beschreibung
`GET /api/search`	Dokumentation durchsuchen (BM25 + Vektor)

Ticket-Classifier

Endpoint	Beschreibung
`POST /api/classify-ticket`	Ticket klassifizieren
`POST /api/classify-ticket/feedback`	Korrektur einsenden
`GET /api/classify-ticket/stats`	Klassifikations-Statistiken

MCP

Endpoint	Beschreibung
`POST /api/mcp`	MCP JSON-RPC Endpoint
`GET /api/mcp`	MCP SSE Stream

Details zu allen Endpoints finden sich in der REST-API Dokumentation.

Code-Generierung

Die OpenAPI-Spec kann fuer die automatische Generierung von Clients genutzt werden, z.B. mit openapi-generator :


# TypeScript-Client generieren
npx @openapitools/openapi-generator-cli generate \
  -i https://docs.processcube.io/api/docs?json \
  -g typescript-fetch \
  -o ./generated/client
 
# Python-Client generieren
npx @openapitools/openapi-generator-cli generate \
  -i https://docs.processcube.io/api/docs?json \
  -g python \
  -o ./generated/client

Die generierte Spec eignet sich auch als Grundlage fuer Postman-Collections oder Insomnia-Workspaces.