Ressourcen · Dokumentation
Plattformdokumentation.
Von Grund auf produktionsreif.
OpenQCore-Dokumentation für Teams, die zuverlässige KI-Produkte für Chat, Sprache, multimodale Generierung und Wissens-Workflows mit gezielter Laufzeitsteuerung entwickeln.
Schnellstart
Vom ersten Request bis zum Produktionseinsatz in Minuten.
1) Authentifizieren
Verwenden Sie JWT-Session-Authentifizierung oder API-Schlüssel-Authentifizierung mit kontextabhängiger Zugriffskontrolle.
2) Laufzeit-Bereich wählen
Setzen Sie bei Bedarf persönlichen oder Workspace-Kontext mithilfe von Runtime-Headern.
3) Chat-Completions aufrufen
Verwenden Sie /api/v1/chat/completions für die Kern-Ausführung des Assistants.
4) Sprache und Multimodalität hinzufügen
Verwenden Sie /api/v1/voice und Iris-Endpunkte für STT/TTS-, Bild-, Video- und OCR-Workflows.
5) Wissen integrieren
Verwenden Sie /api/v1/console/knowledge für Upload, Ingestion und abrufgesteuerte Anfragen.
Basis-URL
Basis der öffentlichen API
/api/v1Alle öffentlichen Plattformendpunkte sind unter /api/v1 verfügbar.
Authentifizierung & Bereich
Kontextbewusster Zugriff für persönliche und Workspace-Ausführungen.
Authentifizierungsmethoden
JWT/Session oder API-Schlüssel
Scope-Header
X-Scope-Type: personal | workspace
Workspace-Header
X-Workspace-ID: [uuid] (erforderlich im Workspace-Bereich)
Agent-Header
X-Agent-ID: [uuid] (optional)
Validierungsregeln
- Wenn scope auf 'personal' gesetzt ist, ist workspace_id nicht erlaubt.
- Wenn scope 'workspace' ist, ist workspace_id erforderlich.
- Ungültige Scope-Header führen zu einem 422-Status.
Ratenbegrenzungen
Richtlinienbasierte Drosselung nach Authentifizierungskontext.
API-Schlüssel
60 Anfragen pro Minute
Der Bucket-Schlüssel verwendet die Hash-Identität des API-Schlüssels.
JWT/Sitzung
120 Anfragen pro Minute
Der Bucket-Schlüssel verwendet die Workspace-ID, wenn vorhanden, andernfalls die Benutzer-ID.
Header für Drosselungsantworten
Chat-Laufzeit
/chat/completions mit Produktionssteuerungsebenen.
GET /api/v1/chat/healthPOST /api/v1/chat/completionsAusführungsverhalten
- Backpressure-Tracking und Zurückweisung bei Systemüberlastung (503).
- Verteiltes Sperrverfahren, um doppelte laufende Verarbeitung zu verhindern (409).
- Dedup-Cache für Nicht-Stream-Antworten.
- Sitzungs- und Nachrichtenpersistenz für Benutzer- und Assistentenbeiträge.
- Laufzeitvalidierung für Anfrage, Anhänge und Sitzungszugriff.
Sprachlaufzeit
STT → LLM → TTS-Pipeline mit Streaming und Unterbrechungsmöglichkeit.
POST /api/v1/voice/chat/metaPOST /api/v1/voice/chatPOST /api/v1/voice/interrupt/{session_id}WS /api/v1/voice/wsSprachfunktionen
- Router für Fallback-Anbieter (OpenAI + Azure).
- Circuit-Breaker für STT-, LLM- und TTS-Phasen.
- Audio-Konvertierungs-Pipeline für Nicht-WAV-Eingaben.
- Streaming-Audioantworten mit Metadaten-Headern.
- Abbruchkontext für sitzungsweite Unterbrechungen.
- Lastabwurf und Qualitätsverschlechterung bei hoher Auslastung.
Iris Multimodal
Modellgesteuerte Bild-, Video-, OCR- und Verifizierungs-Workflows.
Modellkatalog
iris-orbit
Automatischer Routing-Modus
iris-genesis
Bildgenerierung
iris-edit
Bildbearbeitung (nicht implementiert)
iris-lens
Bildanalyse (nicht implementiert)
iris-video
Videogenerierung
iris-ocr
Dokumenten-OCR
iris-verify
Identitätsprüfung
iris-guard
Betrugserkennung (nicht implementiert)
iris-face
Gesichtsverifizierung (nicht implementiert)
Konsolenwissen
APIs für das Workspace-Konsolenwissen zum Import und zur Abfrage.
/api/v1/console/knowledgeGET /api/v1/console/knowledgePOST /api/v1/console/knowledgePOST /api/v1/console/knowledge/uploadGET /api/v1/console/knowledge/{item_id}PATCH /api/v1/console/knowledge/{item_id}DELETE /api/v1/console/knowledge/{item_id}POST /api/v1/console/knowledge/askEinschränkungen für das Wissen
- Maximale Dateigröße: 20MB
- Erlaubte Typen: PDF, DOC, DOCX, TXT, Markdown
- Die Aufnahme erfolgt asynchron im Hintergrund
- Status: pending → processing → processed | failed
Fehlersemantik
Gängige Antwortklassen der Plattform.
400
Ungültige Anfrage, fehlende Daten oder fehlerhafte Eingaben
401
Authentifizierung fehlt oder ungültig
403
Berechtigung nicht erlaubt / Einschränkung der Workspace-Rolle
404
Ressource nicht gefunden
409
Anfrage bereits in Bearbeitung (Sperrkonflikt)
413
Nutzlast zu groß (z. B. Audio-/Dateigrößenbeschränkungen)
415
Nicht unterstützter Inhaltstyp
422
Validierungsfehler (Bereich/Kontext/Schema)
429
Rate-Limit überschritten
503
Systemüberlastung / Anbieter nicht verfügbar
Beobachtbarkeit
Nachverfolgbare Ausführung über Chat- und Sprach-Lebenszyklen.
- Trace-IDs zur Anforderungs-Korrelation.
- Middleware-Pipeline zur Nutzungsprotokollierung.
- OpenTelemetry-Initialisierung mit OTLP-Export.
- Antwort-Header geben Timing-Signale in Sprachabläufen preis.
Dokumentationsnavigation
Dokumentationsabschnitte erkunden
Springen Sie direkt zu Implementierungsanleitungen und Produktionsreferenzen für jede Laufzeitoberfläche.
Authentifizierung
JWT/API-Schlüssel-Authentifizierung, Scope-Header und Validierungsmodell.
Chat-API
Vervollständigungen, Streaming-Verhalten und Laufzeitsteuerungen.
Voice-API
Echtzeit-Sprachpipeline, Unterbrechungsablauf und Metadaten-Header.
Iris-API
Bild-, Video-, OCR- und Verifizierungsendpunkte sowie Routing.
Knowledge-API
Hochladen, Indexierungslebenszyklus, Abruf und Abfrage-Workflows.
Anbieter
Fähigkeitenmatrix, Routing-Richtlinie und Failover-Strategie.
Ausgabeverträge
Einheitliches Antwortformat über Anbieter und Modalitäten hinweg.
Architektur
Laufzeit-Schichten, Anbieterabstraktion und Systemgarantien.
Entwickeln Sie mit Zuversicht in der OpenQCore-Laufzeitumgebung.
Nutzen Sie die Dokumentation als Ihren Produktionsfahrplan für Chat, Sprache, multimodale Generierung und wissensgestützte Ausführung.