Zum Hauptinhalt springen

​
External API Configuration Guide

Sie können API-Anfrage-Definitionen im API-Anfragen-Tab des Voice Wizards erstellen. Klicken Sie auf “API-Anfrage hinzufügen” und Sie sehen das folgende Eingabeformular mit den unten erklärten Feldern. ▶️ Video-Tutorial ansehen API Request Configuration Form

​
Formularfelder erklärt

​
Name der API-Anfrage

Ein beschreibender Name für Ihre API-Anfrage (z. B. “Produktbestellung erstellen”)

​
URL

Die API-Endpunkt-URL. Sie können Platzhalter wie {{userId}} verwenden, die durch Werte aus Ihren dynamischen Funktionsparametern ersetzt werden.
  • Beispiel: https://api.shop.com/orders/{{userId}}

​
HTTP-Methode

Wählen Sie die HTTP-Methode für Ihre Anfrage (GET, POST, PUT, DELETE, etc.)

​
API Key

Ihr Authentifizierungs-Token. Dieser ersetzt automatisch alle {{api_key}}-Platzhalter in Ihrer URL oder in den Headern.

​
Headers

HTTP-Header für Ihre Anfrage im JSON-Format: 
{
  "Authorization": "Bearer {{api_key}}",
  "Content-Type": "application/json"
}
  • {{api_key}} wird durch Ihren API Key ersetzt

​
Funktionsdefinition (Dynamische Parameter)

Definieren Sie die Parameter, die Benutzer beim Aufruf Ihrer Funktion übergeben können: 
{
  "type": "function",
  "name": "place_order",
  "description": "Bestellt ein Produkt für einen Kunden",
  "parameters": {
    "type": "object",
    "properties": {
      "userId": {
        "type": "string",
        "description": "Kunden-Benutzer-ID"
      },
      "orderDetails": {
        "type": "object",
        "properties": {
          "product": {"type": "string"},
          "quantity": {"type": "number"}
        }
      }
    }
  }
}
Diese Parameter werden:
  • Passende Platzhalter in URL und Headern ersetzen
  • Alle dynamischen Parameter, die nicht mit Platzhaltern übereinstimmen, werden in den Request Body eingefügt
  • Funktioniert mit verschachtelten Objekten - z. B. wird das orderDetails-Objekt im Body beibehalten

​
Feste Parameter

Statische Werte, die immer in jeder Anfrage enthalten sind: 
{
  "storeId": "STORE_123",
  "paymentMethod": "credit_card",
  "currency": "USD"
}
Diese werden:
  • Immer unverändert in den Request Body eingefügt
  • Sie ersetzen KEINE Platzhalter in Headern oder URL

​
Vorher sagen

Eine optionale Nachricht, die der AI-Assistent dem Benutzer mitteilt, bevor die API-Anfrage ausgeführt wird. Zum Beispiel: “Ich erstelle jetzt Ihre Bestellung…” oder “Einen Moment, ich rufe die Produktinformationen ab…”

​
Beispiel: GET-Anfrage ohne dynamische Parameter

Manche API-Aufrufe benötigen keine Parameter von der KI - zum Beispiel “Alle Produkte abrufen”. In diesem Fall ist trotzdem eine Funktionsdefinition erforderlich, damit die KI die API-Anfrage auslöst. API Request Configuration for GET without parameters

​
Konfiguration für “Get all products”:

  • Name der API-Anfrage: “Get all products”
  • URL: https://aipro.proxy.beeceptor.com/products
  • HTTP-Methode: GET
  • API Key: (leer oder Ihr API-Schlüssel)
  • Headers: Standard-GET-Headers

​
Funktionsdefinition ohne Parameter:

Klicken Sie auf “Keine dynamischen Parameter” um eine Vorlage zu erhalten: 
{
  "type": "function",
  "name": "listProducts",
  "description": "Get all available products from the catalog",
  "parameters": {
    "type": "object",
    "properties": {}
  }
}
Wichtig:
  • Ein aussagekräftiger Funktionsname und eine Beschreibung sind entscheidend, weil die KI verstehen muss, wann die Funktion aufgerufen werden soll
  • Fügen Sie explizite Anweisungen im Benutzer-Prompt hinzu, falls die KI Schwierigkeiten hat
  • Die leeren properties: {} sind erforderlich für eine gültige Funktionsdefinition

​
Resultierende HTTP-Anfrage:

Basierend auf der obigen Konfiguration wird folgende HTTP-Anfrage erstellt: 
GET https://aipro.proxy.beeceptor.com/products
Content-Type: application/json
Erklärung:
  • URL: Direkte URL ohne Platzhalter-Ersetzungen
  • Headers: GET-Headers mit Bearer API Token
  • Parameter: Keine dynamischen Parameter erforderlich

​
Wie die endgültige Anfrage erstellt wird

  1. URL: Platzhalter werden durch dynamische Funktionsparameter ersetzt
  2. Headers: {{api_key}} → API Key, andere Platzhalter → dynamische Parameterwerte
  3. Body: Kombination aus Festen Parametern + dynamischen Parametern, die nicht mit Platzhaltern übereinstimmen

​
Beispiel der endgültigen HTTP-Anfrage

Basierend auf den obigen Parametern wird folgende HTTP-Anfrage erstellt: 
POST https://api.shop.com/orders/user123
Authorization: Bearer YOUR_API_KEY_HERE
Content-Type: application/json

{
  "storeId": "STORE_123",
  "paymentMethod": "credit_card",
  "currency": "USD",
  "orderDetails": {
    "product": "Wireless Headphones",
    "quantity": 2
  }
}
Erklärung:
  • URL: {{userId}} wurde durch “user123” ersetzt
  • Headers: {{api_key}} wurde durch Ihren tatsächlichen API Key ersetzt
  • Body: Enthält sowohl feste Parameter (storeId, paymentMethod, currency) als auch dynamische Parameter (orderDetails)