Übersicht

Postman

Postman ist ein mächtiges Tool für die Entwicklung und das Testen von APIs. Es ermöglicht Ihnen, APIs komfortabel zu erstellen, zu verwalten und zu testen. GPTBots stellt Postman Collections für ein unkompliziertes Testen von APIs zur Verfügung.
GPTBots Postman Collections

Grundlegende Einschränkungen

Die GPTBots API entspricht den HTTP- und REST-Standards. Abfragen werden mit der GET-Methode durchgeführt, Übermittlungen mit der POST-Methode. Wird eine Anfrage nicht mit der jeweils vorgesehenen HTTP-Methode gestellt, gibt die API eine Fehlermeldung zurück.

Parameterwerte sollten, sofern nicht anders angegeben, in UTF-8 kodiert und URL-codiert sein.

Authentifizierung

Die GPTBots REST API nutzt die HTTP-Basic-Authentifizierung. Fügen Sie den folgenden Authorization-Header hinzu:

Authorization: Bearer ${API_Key}

                      
                      Authorization: Bearer ${API_Key}

Dieser Codeblock im schwebenden Fenster

API-Aktivierung

Um den API-Service zu aktivieren, öffnen Sie das GPTBots-Dashboard, navigieren Sie zu „Agent Integration“, wählen Sie „Development-API Service“ und klicken Sie auf „Aktivieren“, um den API-Service zu aktivieren.
Nach der Aktivierung wählen Sie die „API“-Karte, um zur API-Verwaltung zu gelangen. Klicken Sie auf „APIKey erstellen“, um einen API-Schlüssel zu generieren, mit dem Sie die GPTBots APIs nutzen können.

API-Basis-URLs

API-URL-Format:

https://api-${endpoint}.gptbots.ai/

Das {endpoint} bezeichnet das Rechenzentrum, das Sie bei der Einrichtung Ihrer Organisation gewählt haben. Wählen Sie das passende {endpoint} entsprechend Ihren Anforderungen.

Rechenzentrum-Liste

Die verfügbaren Rechenzentren für die GPTBots-Plattform sind unten aufgeführt:

Rechenzentrum	Endpoint	API-Basis-URL
Singapur	sg	`https://api-sg.gptbots.ai/`
Japan	jp	`https://api-jp.gptbots.ai/`
Thailand	th	`https://api-th.gptbots.ai/`

Wenn im API-Request-URL kein -{endpoint} angegeben wird, nutzt die Plattform standardmäßig das Rechenzentrum Singapur.
Alle API-Anfragen müssen den entsprechenden Endpoint-Pfad enthalten. Beispiel: Für eine Organisation im Rechenzentrum Singapur lautet die API-Request-URL: https://api-sg.gptbots.ai/v2/conversation

API-Kategorien

Die GPTBots-Plattform bietet eine umfassende Auswahl an API-Schnittstellen für Ihre Geschäftsanforderungen. Sie können die passenden APIs je nach Bedarf auswählen. Die API-Kategorien sind wie folgt:

API-Kategorie	Beschreibung
Conversation API	Über diese API können Sie mit Agenten interagieren und kommunizieren.
Workflow API	Über diese API können Sie Anfragen an Workflows senden und Antworten empfangen.
Knowledge API	Verwalten Sie Wissensdatenbanken auf der GPTBots-Plattform über diese API.
Database API	Verwalten Sie Datenbanken auf der GPTBots-Plattform über diese API.
Models API	Greifen Sie über diese API auf verschiedene Modellfunktionen der GPTBots-Plattform zu.
User API	Konfigurieren Sie Benutzerinformationen, Attribute und Kontaktdaten über diese API.
Analytics API	Abfragen von Verbrauchsdaten für Credits und Tokens über diese API.
Account API	Abrufen von Informationen zu Agenten, Organisationen usw. unter dem Account über diese API.

API-Rate-Limits

Die GPTBots-Plattform setzt Rate-Limits für API-Aufrufe, die je nach API-Kategorie variieren. Bei Überschreitung der Limits erhalten Sie eine Rate-Limit-Fehlermeldung. Die konkreten Limits sind:

Im kostenlosen Tarif sind alle API-Typen auf 3 Anfragen pro Minute begrenzt.
Im Enterprise Custom Tarif kontaktieren Sie bitte den GPTBots Vertrieb, um individuelle API-Rate-Limits zu vereinbaren.