Skip to main content
POST
https://app.famulor.de/api/
/
user
/
tools
Mid-Call-Tool erstellen
curl --request POST \
  --url https://app.famulor.de/api/user/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "endpoint": "<string>",
  "method": "<string>",
  "timeout": 123,
  "headers": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "schema": [
    {
      "name": "<string>",
      "type": "<string>",
      "description": "<string>"
    }
  ]
}
'
{
  "message": "Tool created successfully",
  "data": {
    "id": 1,
    "name": "check_order_status",
    "description": "Use this tool to check the status of a customer's order.",
    "endpoint": "https://app.famulor.de/orders/status",
    "method": "GET",
    "timeout": 10,
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json"
      },
      {
        "name": "Authorization",
        "value": "Bearer sk_..."
      }
    ],
    "schema": [
      {
        "name": "order_id",
        "type": "string",
        "description": "The customer's order ID"
      },
      {
        "name": "order_number",
        "type": "number",
        "description": "The numeric order number"
      },
      {
        "name": "priority_order",
        "type": "boolean",
        "description": "Whether this is a priority order"
      }
    ],
    "created_at": "2025-10-10T12:00:00.000000Z",
    "updated_at": "2025-10-10T12:00:00.000000Z"
  }
}
Dieser Endpunkt ermöglicht es Ihnen, ein neues Mid-Call-Tool zu erstellen, das von Ihren KI-Assistenten verwendet werden kann, um während Anrufen mit externen APIs zu interagieren.

​
Body-Parameter

​
name
string
required
Tool-Name - darf nur Kleinbuchstaben und Unterstriche enthalten und muss mit einem Buchstaben beginnen (z.B. get_weather, book_appointment)
​
description
string
required
Detaillierte Erklärung, wann und wie die KI dieses Tool verwenden soll (max. 255 Zeichen)
​
endpoint
string
required
Gültige URL des aufzurufenden API-Endpunkts
​
method
string
required
HTTP-Methode: GET, POST, PUT, PATCH oder DELETE
​
timeout
integer
Request-Timeout in Sekunden (1-30, Standard: 10)
​
headers
array
HTTP-Header, die mit der Anfrage gesendet werden sollen
​
schema
array
Parameter, die die KI aus der Unterhaltung extrahieren und an den Endpunkt senden wird

​
Antwortfelder

​
message
string
Erfolgsmeldung
​
data
object
Das erstellte Tool-Objekt
{
  "message": "Tool created successfully",
  "data": {
    "id": 1,
    "name": "check_order_status",
    "description": "Use this tool to check the status of a customer's order.",
    "endpoint": "https://app.famulor.de/orders/status",
    "method": "GET",
    "timeout": 10,
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json"
      },
      {
        "name": "Authorization",
        "value": "Bearer sk_..."
      }
    ],
    "schema": [
      {
        "name": "order_id",
        "type": "string",
        "description": "The customer's order ID"
      },
      {
        "name": "order_number",
        "type": "number",
        "description": "The numeric order number"
      },
      {
        "name": "priority_order",
        "type": "boolean",
        "description": "Whether this is a priority order"
      }
    ],
    "created_at": "2025-10-10T12:00:00.000000Z",
    "updated_at": "2025-10-10T12:00:00.000000Z"
  }
}

​
Tools zu Assistenten hinzufügen

Nach dem Erstellen eines Tools müssen Sie es einem Assistenten zuweisen, um es während Anrufen zu verwenden. Tools werden über die Assistenten-API verwaltet:
  • Assistent erstellen - Verwenden Sie den tool_ids-Parameter, um Tools beim Erstellen eines Assistenten zuzuweisen
  • Assistent aktualisieren - Verwenden Sie den tool_ids-Parameter, um Tools bei einem bestehenden Assistenten hinzuzufügen, zu entfernen oder zu ersetzen