Zum Inhalt springen

API — Rezepte

Diese setzen voraus, dass Sie BQP_BASE und BQP_KEY aus dem Schnellstart gesetzt haben. Jeder Aufruf sendet Authorization: Bearer $BQP_KEY.

Ein Dokument importieren und darüber chatten

Terminal-Fenster
# 1. Datenquelle erstellen → liefert ihre id
curl -s "$BQP_BASE/v1/datasources" \
-H "Authorization: Bearer $BQP_KEY" -H "Content-Type: application/json" \
-d '{"name":"Richtlinien"}'
# → { "id": "DS_ID", ... }
# 2. PDF hochladen (multipart) → 202 Accepted mit Dokument- und Job-id
curl -s "$BQP_BASE/v1/datasources/DS_ID/documents" \
-H "Authorization: Bearer $BQP_KEY" \
-F "file=@handbuch.pdf"
# → { "document_id": "DOC_ID", "job_id": "JOB_ID" }
# 3. abfragen, bis die Verarbeitung fertig ist (Status: parsing → embedding → tagging → "ready")
curl -s "$BQP_BASE/v1/documents/DOC_ID" -H "Authorization: Bearer $BQP_KEY"
# → { ..., "status": "ready" } # "failed" = Verarbeitung fehlgeschlagen (siehe Feld "error")
# 4. eine fundierte Frage stellen, beschränkt auf die Datenquelle
curl -s "$BQP_BASE/v1/chat" \
-H "Authorization: Bearer $BQP_KEY" -H "Content-Type: application/json" \
-d '{"message":"Wie lautet unsere Rückgaberichtlinie?","datasource_ids":["DS_ID"]}'
# → { "session_id": "...", "answer": "...", "trace": [ ...Belege... ], "model": "..." }

trace enthält die Werkzeugaufrufe und Passagen hinter der Antwort — die Belege. Geben Sie die zurückgegebene session_id beim nächsten Aufruf mit, um dieselbe Unterhaltung fortzusetzen.

Einen regulierten Vorschlag ausführen

Terminal-Fenster
# einen Berater wählen, dem Datenquellen zugeordnet sind
curl -s "$BQP_BASE/v1/personas" -H "Authorization: Bearer $BQP_KEY"
# 1. eine Empfehlung anfordern (der Berater entwirft sie)
curl -s "$BQP_BASE/v1/proposals" \
-H "Authorization: Bearer $BQP_KEY" -H "Content-Type: application/json" \
-d '{"persona_id":"PERSONA_ID","situation":"Sollten wir die Preise nächstes Quartal um 10 % erhöhen?"}'
# → { "id": "PROP_ID", "status": "proposed", "recommendation": "...", "evidence": [...] }
# 2a. ein Prüfer genehmigt sie …
curl -s "$BQP_BASE/v1/proposals/PROP_ID/verdict" \
-H "Authorization: Bearer $BQP_KEY" -H "Content-Type: application/json" \
-d '{"verdict":"approved","reason":"Im Einklang mit der Strategie"}'
# 2b. … oder bittet den Berater um Verfeinerung (neu generiert, bleibt "proposed")
curl -s "$BQP_BASE/v1/proposals/PROP_ID/regenerate" \
-H "Authorization: Bearer $BQP_KEY" -H "Content-Type: application/json" \
-d '{"suggestions":"Sei vorsichtiger bei der Abwanderung; beginne mit einer klaren Go/No-Go-Empfehlung."}'

verdict ist approved oder rejected, und eine Entscheidung ist endgültig. Entscheiden erfordert einen Prüfer oder Admin; Anfordern nicht. Vorschläge sind eine Organisationsfunktion.

Einen externen KI-Client verbinden (MCP)

Damit Claude Desktop, Cursor oder ein anderer MCP-Client Ihr Wissen direkt durchsuchen kann, nutzen Sie die fertige Client-Konfiguration unter Studio → MCP in der App — siehe Integrationen & MCP. Sie authentifiziert sich mit demselben API-Schlüssel.