Zum Inhalt springen
Dokumentation

Eigene API-Aktionen: deine API aus dem Chat aufrufen

Lass deinen intoCHAT-Agenten im Chat deine HTTP-API aufrufen: Anfrage und Authentifizierung, cURL-Import, Eingaben aus dem Gespräch und Test.

Mit einer eigenen API-Aktion ruft der Agent während des Gesprächs einen HTTP-Endpunkt auf, etwa um aktuellen Lagerbestand oder Preise abzufragen, und antwortet auf Basis der Antwort. Aktionen legst du im Tab Actions (Aktionen) deines Agenten an. Soll der Agent einen Link anbieten, statt eine API aufzurufen, siehe Eigene Buttons.

Aktion anlegen

Klicke auf Add Action oder auf Import a request, um mit einem cURL-Befehl zu starten. Der Editor hat vier Schritte, gespeichert wird einmal am Ende mit Create action. Ein Test ist freiwillig, aber empfehlenswert.

1. The request (die Anfrage)

  • Method: GET, POST, PUT, PATCH oder DELETE.
  • HTTPS URL: der Endpunkt. Ein Query-String in der URL wird in den Tab Parameters verschoben.
  • Parameters, Headers und Body nehmen Schlüssel-Wert-Paare auf. Body gibt es bei allen Methoden außer GET, er wird als JSON gesendet.
  • Collect data inputs for action (optional): Werte, die der Agent aus dem Gespräch füllt. Jede Eingabe hat einen Name (Buchstaben, Ziffern und Unterstriche), einen Type (Text, Number oder Boolean), eine Description sowie die Optionen Required und Array. Bis zu 25 Eingaben pro Aktion.

Verwende eine Eingabe überall in der Anfrage als {{name}}, im URL-Pfad, in einem Parameter, einem Header oder im Body:

GET https://api.example.com/products/{{productId}}/stock

Der Agent findet den Wert im Gespräch oder fragt den Besucher danach. Eine Eingabe mit Required verhindert, dass der Agent die Aktion aufruft, bevor er den Wert hat. Variablen, die benutzt, aber nicht als Eingabe angelegt sind, fallen aus der Anfrage heraus; der Editor warnt dich und bietet Add them an.

Authentifizierung

OptionWas gesendet wird
No authenticationNichts
Bearer token / access tokenEin Header Authorization: Bearer mit deinem Token
API key in a headerDein Schlüssel in dem Header, den du angibst, etwa X-API-Key
API key in the URLDein Schlüssel als Query-Parameter mit dem Namen, den du angibst, etwa api_key
Username and passwordHTTP-Basic-Authentifizierung
Custom — I'll set the headers myselfWas du im Tab Headers einträgst

Anfrage importieren

Füge das cURL-Beispiel aus der Dokumentation deiner API ein oder nutze „Copy as cURL“ für eine Anfrage in den Netzwerk-Tools deines Browsers. Methode, URL, Query-Parameter, Header und Body werden ausgefüllt, die Zugangsdaten landen in der Auswahl Authentication. Der Import ersetzt die Anfrage, Name und Beschreibung bleiben erhalten. Multipart-Uploads (-F) werden übersprungen, ein formularcodierter Body wird als JSON-Felder übernommen.

2. Try it (testen)

Gib Testwerte für die Eingaben ein und klicke auf Send test request. Die Anfrage wird genau so gebaut, wie der Agent sie baut. Die Response Preview zeigt Status, Antwort und die aufgerufene URL.

3. When the AI should use it (wann die KI sie nutzt)

  • Action Name: bis zu 60 Zeichen.
  • When to use: was die Aktion tut, welche Daten sie liefert und Beispielfragen, bei denen sie greifen soll. Das Modell liest die ersten 1.024 Zeichen.
  • Server-side action läuft auf den Servern von intoCHAT und ist die Voreinstellung. Client-side action läuft im Browser des Besuchers, siehe Client-seitige Aktionen.
  • Enable this action: schaltet eine Aktion ab, ohne sie zu löschen.

4. What the AI can see (was die KI sieht)

Full data access gibt die ganze Antwort an das Modell weiter. Limited data access gibt nur die Felder weiter, die du unter Visible anhakst; führe zuerst einen Test aus, damit die Feldliste erscheint. Ist die Antwort eine Liste, kommen die Felder aus dem ersten Eintrag und der Filter gilt für alle Einträge. Solange kein Feld angehakt ist, wird die ganze Antwort weitergegeben.

Grenzen und Sicherheit

  • Bis zu 25 Aktionen pro Agent, einschließlich eigener Buttons und der Aktionen aus Shop verbinden.
  • Die URL muss auf einen öffentlichen Host zeigen. Localhost, private Netze, Link-Local-Adressen und Cloud-Metadaten-Endpunkte werden abgelehnt, auch wenn ein Hostname auf eine solche Adresse auflöst. Der Editor zeigt dann „URL points to a blocked or internal host“.
  • Weiterleitungen werden nicht verfolgt. Zeigt der Test „This address redirects somewhere else“, klicke auf Use this address.
  • Jeder Aufruf bricht nach 30 Sekunden ab.
  • Antworten über 40.000 Zeichen werden abgeschnitten. Mit Limited data access bleiben sie klein.
  • Server-seitige Aktionen senden deine Zugangsdaten von den Servern von intoCHAT, nie über den Browser des Besuchers.

Als Markdown anzeigen