API Referenz
Diese Seite beschreibt, wie du die REST-API von CLYE AI für eigene Integrationen nutzt. Die interaktive Referenz mit allen Endpunkten, Parametern und einem Try-it-out liegt unter API.
Nutze sie zusammen mit den Abschnitten zu API-Keys, Authentifizierung und Einbettung, wenn du eigene Anwendungen anbindest.
Interaktive Referenz
Die OpenAPI-Dokumentation unter /api listet die aktuellen Endpunkte. Dort kannst du:
- Endpunkte nach Themen filtern
- Request- und Response-Schemas nachschlagen
- Aufrufe direkt gegen deine AI-Hub-URL testen, sobald du sie oben rechts eingetragen hast
Die Basis-URL der API ist https://clye.ai/api. In On-Premise-Umgebungen ersetzt du den Host durch deine eigene Instanz.
Authentifizierung
Programmatische Zugriffe laufen über einen API-Key im Header:
Authorization: Bearer dein-api-key-here
Content-Type: application/json
Je nach Endpunkt gelten zusätzlich Session-Cookies (Browser) oder ein JWT, etwa bei Widgets und Assistant Access Links.
Typische Einstiege
| Ziel | Seite |
|---|---|
| Schlüssel anlegen und Scopes setzen | API-Keys verwalten |
| Chat in einer Website einbetten | Chat einbetten und Widgets |
| Assistenten per Link teilen | Assistant Access Link |
| OpenAI-kompatible Modelle nutzen | LLM Gateway |
| Endpunkte interaktiv testen | API Explorer |