Dieses Dokument beschreibt die verfügbaren API-Endpunkte zur Verwaltung von KI-Credits und zur Generierung von KI-gestützten Antworten im System. Es enthält Details dazu, wie verfügbare Credits überprüft und genutzt werden können, um Antworten basierend auf Benutzereingaben zu generieren.
API für KI-Credits
Header:
Authorization: Bearer {your_bearer_token}
Beschreibung: Dieser API-Endpunkt liefert Details über die insgesamt verfügbaren KI-Credits und die Anzahl der genutzten KI-Credits. Der Wert der gesamten KI-Credits wird „unbegrenzt“ sein, wenn der Arbeitsbereich unbegrenzten Zugriff hat.
Antwort:
total_ai_credits (integer, kann auch ein String sein im Falle von unbegrenztem Zugriff): Die insgesamt verfügbaren KI-Credits.
used_ai_credits (integer): Die Anzahl der genutzten KI-Credits.
Beispielantwort:
{
"total_ai_credits": 20,
"used_ai_credits": 17
}API für KI-generierte Antworten
Endpunkt:
GET https://app.dotsimple.io/app/api/{workspace_uuid}/ai/generate-response
Header:
Authorization: Bearer {your_bearer_token}
Anfrageparameter:
prompt (erforderlich): Der Texteingabe für die Generierung einer Antwort (String).
language (optional): Sprache der Antwort. Akzeptierte Werte:
'english'
'german'
Beschreibung: Diese API generiert eine Antwort basierend auf dem bereitgestellten Prompt und der Sprachpräferenz. Sie verbraucht KI-Credits und gibt die generierte Antwort zurück.
Antwort:
text (string): Die generierte Antwort basierend auf der Eingabeaufforderung.
total_ai_credits (Ganzzahl, kann auch ein String sein bei unbegrenztem Zugriff): Die insgesamt verfügbaren KI-Credits nach der Anfrage.
used_ai_credits (Ganzzahl): Die Anzahl der für die Anfrage verwendeten KI-Credits.
Beispielantwort:
{
"text": "Das Leben ist ein wunderschönes Geflecht aus Momenten der Freude,
Herausforderung, Liebe und Wachstum. Es ist eine Reise, bei der jeder Tag
neue Lektionen und Möglichkeiten bietet. Umarme die Gegenwart, schätze
Verbindungen und finde Schönheit im Alltäglichen. Denke daran, es geht
nicht nur um das Ziel, sondern um die Erfahrungen, die uns auf dem Weg
formen. Lebe voll und ganz, liebe tief und strebe immer danach, zu lernen
und zu wachsen.",
"total_ai_credits": 20,
"used_ai_credits": 17
}Hinweis: Stelle sicher, {workspace_uuid} durch die tatsächliche Workspace-UUID und {your_bearer_token} durch deinen gültigen Bearer-Token zu ersetzen.