API Requests

​

Form fields explained

​

API request name

​

URL

• Example: https://api.shop.com/orders/{{userId}}

​

HTTP method

​

API key

​

Headers

{
  "Authorization": "Bearer {{api_key}}",
  "Content-Type": "application/json"
}

• {{api_key}} is replaced with your API key

​

Function definition (dynamic parameters)

{
  "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"}
        }
      }
    }
  }
}

• Replace matching placeholders in the URL and headers
• All dynamic parameters that do not match any placeholder are added to the request body
• Works with nested objects — e.g. the orderDetails object is preserved in the body

​

Fixed parameters

{
  "storeId": "STORE_123",
  "paymentMethod": "credit_card",
  "currency": "USD"
}

• Always added to the request body unchanged
• They do NOT replace placeholders in headers or the URL

​

Say before

​

Example: GET request without dynamic parameters

​

Configuration for “Get all products”

• API request name: “Get all products”
• URL: https://example.proxy.beeceptor.com/products (example test endpoint)
• HTTP method: GET
• API key: (empty or your API key)
• Headers: Standard GET headers

​

Function definition without parameters

{
  "type": "function",
  "name": "listProducts",
  "description": "Get all available products from the catalog",
  "parameters": {
    "type": "object",
    "properties": {}
  }
}

• A meaningful function name and description are crucial, because the AI needs to understand when to call the function
• Add explicit instructions in the user prompt if the AI has trouble
• The empty properties: {} is required for a valid function definition

​

Resulting HTTP request

GET https://example.proxy.beeceptor.com/products
Content-Type: application/json

• URL: Direct URL without placeholder substitutions
• Headers: GET headers with Bearer API token
• Parameters: No dynamic parameters required

​

How the final request is built

1. URL: Placeholders are replaced with dynamic function parameters
2. Headers: {{api_key}} is replaced with the API key, other placeholders with dynamic parameter values
3. Body: Combination of fixed parameters + dynamic parameters that don’t match any placeholder

​

Example of the final HTTP request

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
  }
}

• URL: {{userId}} was replaced with “user123”
• Headers: {{api_key}} was replaced with your actual API key
• Body: Contains both fixed parameters (storeId, paymentMethod, currency) and dynamic parameters (orderDetails)