VAPI•7mo ago

Tools type apiRequest Not accepting Headers and Request Body

Hi, Im trying to integrate Tools type apiRequest. Its connecting, in dashboard Vapi the Tool Name, Headers and Body/parameters is empty but returned in response.

Do I missed something?
Thank You

@Shubham Bajaj @ivy

  -H 'Authorization: Bearer xxx-xx-xx-xxx-xxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "function": {
    "name": "API",
    "strict": false,
    "description": "Transfer API",
    "parameters": {
      "type": "object",
      "properties": {
        "name": {
          "description": "name",
          "type": "string"
        },
        "address": {
          "type": "string"
        }
      }
    }
  },
  "messages": [
    {
      "type": "request-start",
      "content": "hello",
      "conditions": []
    },
    {
      "type": "request-complete",
      "content": "test",
      "conditions": []
    },
    {
      "type": "request-failed",
      "content": "sorry",
      "conditions": []
    },
    {
      "type": "request-response-delayed",
      "content": "Wait",
      "conditions": []
    }
  ],
  "server": {
    "timeoutSeconds": 20,
    "headers": {
      "token": "123"
    }
  },
  "async": false,
  "url": "https://www.vapi.ai",
  "method": "POST"
}'
--- END CURL ---

VAPI Tool Update Response: {
  id: 'd27c7c62-0e34-49f1-8c72-f35d06e46065',
...
  type: 'apiRequest',
  function: {
    name: 'API',
    strict: false,
    description: 'Transfer API',
    parameters: { type: 'object', properties: [Object] }
  },
  orgId: '218761d7-4a06-4459-9fdc-d4c0a66490d2',
  server: { timeoutSeconds: 20, headers: { token: '123' } },
...
}

  -H 'Authorization: Bearer xxx-xx-xx-xxx-xxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "function": {
    "name": "API",
    "strict": false,
    "description": "Transfer API",
    "parameters": {
      "type": "object",
      "properties": {
        "name": {
          "description": "name",
          "type": "string"
        },
        "address": {
          "type": "string"
        }
      }
    }
  },
  "messages": [
    {
      "type": "request-start",
      "content": "hello",
      "conditions": []
    },
    {
      "type": "request-complete",
      "content": "test",
      "conditions": []
    },
    {
      "type": "request-failed",
      "content": "sorry",
      "conditions": []
    },
    {
      "type": "request-response-delayed",
      "content": "Wait",
      "conditions": []
    }
  ],
  "server": {
    "timeoutSeconds": 20,
    "headers": {
      "token": "123"
    }
  },
  "async": false,
  "url": "https://www.vapi.ai",
  "method": "POST"
}'
--- END CURL ---

VAPI Tool Update Response: {
  id: 'd27c7c62-0e34-49f1-8c72-f35d06e46065',
...
  type: 'apiRequest',
  function: {
    name: 'API',
    strict: false,
    description: 'Transfer API',
    parameters: { type: 'object', properties: [Object] }
  },
  orgId: '218761d7-4a06-4459-9fdc-d4c0a66490d2',
  server: { timeoutSeconds: 20, headers: { token: '123' } },
...
}

  -H 'Authorization: Bearer xxx-xx-xx-xxx-xxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "function": {
    "name": "API",
    "strict": false,
    "description": "Transfer API",
    "parameters": {
      "type": "object",
      "properties": {
        "name": {
          "description": "name",
          "type": "string"
        },
        "address": {
          "type": "string"
        }
      }
    }
  },
  "messages": [
    {
      "type": "request-start",
      "content": "hello",
      "conditions": []
    },
    {
      "type": "request-complete",
      "content": "test",
      "conditions": []
    },
    {
      "type": "request-failed",
      "content": "sorry",
      "conditions": []
    },
    {
      "type": "request-response-delayed",
      "content": "Wait",
      "conditions": []
    }
  ],
  "server": {
    "timeoutSeconds": 20,
    "headers": {
      "token": "123"
    }
  },
  "async": false,
  "url": "https://www.vapi.ai",
  "method": "POST"
}'
--- END CURL ---

VAPI Tool Update Response: {
  id: 'd27c7c62-0e34-49f1-8c72-f35d06e46065',
...
  type: 'apiRequest',
  function: {
    name: 'API',
    strict: false,
    description: 'Transfer API',
    parameters: { type: 'object', properties: [Object] }
  },
  orgId: '218761d7-4a06-4459-9fdc-d4c0a66490d2',
  server: { timeoutSeconds: 20, headers: { token: '123' } },
...
}

  -H 'Authorization: Bearer xxx-xx-xx-xxx-xxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "function": {
    "name": "API",
    "strict": false,
    "description": "Transfer API",
    "parameters": {
      "type": "object",
      "properties": {
        "name": {
          "description": "name",
          "type": "string"
        },
        "address": {
          "type": "string"
        }
      }
    }
  },
  "messages": [
    {
      "type": "request-start",
      "content": "hello",
      "conditions": []
    },
    {
      "type": "request-complete",
      "content": "test",
      "conditions": []
    },
    {
      "type": "request-failed",
      "content": "sorry",
      "conditions": []
    },
    {
      "type": "request-response-delayed",
      "content": "Wait",
      "conditions": []
    }
  ],
  "server": {
    "timeoutSeconds": 20,
    "headers": {
      "token": "123"
    }
  },
  "async": false,
  "url": "https://www.vapi.ai",
  "method": "POST"
}'
--- END CURL ---

VAPI Tool Update Response: {
  id: 'd27c7c62-0e34-49f1-8c72-f35d06e46065',
...
  type: 'apiRequest',
  function: {
    name: 'API',
    strict: false,
    description: 'Transfer API',
    parameters: { type: 'object', properties: [Object] }
  },
  orgId: '218761d7-4a06-4459-9fdc-d4c0a66490d2',
  server: { timeoutSeconds: 20, headers: { token: '123' } },
...
}

Vapi Support BotAPP•6/4/25, 1:50 AM

Thank you for sharing the details. To help diagnose the issue: Are you configuring the tool via the Vapi dashboard UI, the API, or both—and does the problem persist after refreshing or re-saving the tool in the dashboard?

This will help determine if the issue is related to the dashboard display or the API configuration.

Sources:

⤵️ Mention @Vapi Support Bot for follow-ups 🐥

Lltd-scarlet Thank you for sharing the details. To help diagnose the issue: **Are you configu...

brilliant-orangeOP•6/4/25, 2:01 AM

Configurations from API

VVapi Support Bot Thank you for sharing the details. To help diagnose the issue: **Are you configu...

DuckieAPP•6/4/25, 2:38 AM

Message marked as helpful by @! AetherMind!

Lltd-scarlet Thank you for sharing the details. To help diagnose the issue: **Are you configu...

specific-silver•6/5/25, 10:28 AM

API

specific-silver•6/5/25, 10:28 AM

Hi @Shubham Bajaj are you able to assist here?

KyleAPP•6/6/25, 3:21 AM

Are you having the same issue @ivy?

specific-silver•6/9/25, 8:25 AM

yes

KyleAPP•6/9/25, 7:40 PM

Could you share the request you are sending?

Ccomprehensive-tomato Could you share the request you are sending?

specific-silver•6/11/25, 4:09 AM

@Gilang can you please share to Kyle?

Bbrilliant-orange Hi, Im trying to integrate Tools type apiRequest. Its connecting, in dashboard ...

brilliant-orangeOP•6/11/25, 4:11 AM

This one, @kylebrunker @ivy

KyleAPP•6/11/25, 6:58 AM

I am looking at the request, but I am still not quite understanding what you are trying to achieve here. Could you please describe what your desired result is from this request?

specific-silver•6/11/25, 7:02 AM

There is no response received but this it looks like the API is trigerring

specific-silver•6/11/25, 7:02 AM

so unsure why there is no response

KyleAPP•6/11/25, 7:09 AM

If you haven't looked at the documentation already, please review it for finding the correct format of API requests: https://docs.vapi.ai/api-reference/calls/list

Ccomprehensive-tomato If you haven't looked at the documentation already, please review it for finding...

brilliant-orangeOP•6/12/25, 1:58 AM

This is API Create Tool type apiRequest ; https://api.vapi.ai/tool
In request i sent this the headers and token:

  "server": {
    "timeoutSeconds": 20,
    "headers": {
      "token": "123"
    }
  },

  "server": {
    "timeoutSeconds": 20,
    "headers": {
      "token": "123"
    }
  },

and respose from this request, i got this headers and token:

server: { timeoutSeconds: 20, headers: { token: '123' } },

server: { timeoutSeconds: 20, headers: { token: '123' } },

But it not showing in vapi dashboard tools. I dont know is this correct or not?

KyleAPP•6/13/25, 3:40 AM

Here is the required fields for the apiRequest tool:

{
  "type": "apiRequest",
  "method": "POST" | "GET",
  "url": "https://your-api-endpoint.com/path",
  "body": {
    "type": "object",
    "properties": {
      "paramName": {
        "type": "string",
        "description": "Parameter description"
      }
    }
  }
  "name": "myApiTool",
  "description": "Description of what this tool does",
  "headers": {
    "type": "object", 
    "properties": {
      "Authorization": {
        "type": "string",
        "value": "Bearer {{usertoken}}"
      }
    }
  },
  "timeoutSeconds": 20,
  "backoffPlan": {
    "backoffType": "exponential",
    "maxRetries": 3
  }
}

{
  "type": "apiRequest",
  "method": "POST" | "GET",
  "url": "https://your-api-endpoint.com/path",
  "body": {
    "type": "object",
    "properties": {
      "paramName": {
        "type": "string",
        "description": "Parameter description"
      }
    }
  }
  "name": "myApiTool",
  "description": "Description of what this tool does",
  "headers": {
    "type": "object", 
    "properties": {
      "Authorization": {
        "type": "string",
        "value": "Bearer {{usertoken}}"
      }
    }
  },
  "timeoutSeconds": 20,
  "backoffPlan": {
    "backoffType": "exponential",
    "maxRetries": 3
  }
}

Ccomprehensive-tomato Here is the required fields for the apiRequest tool: ``` { "type": "apiReques...

brilliant-orangeOP•6/18/25, 2:21 AM

is there any documentations that can i read. the structures different with publish documentations. Or do i miss something?

KyleAPP•6/19/25, 3:30 AM

The API documentation should be up to date. If you see any discrepancies please take a screenshot of response that you get from the server and request payload used

Tools type apiRequest Not accepting Headers and Request Body

Similar Threads

Similar Threads

Similar Threads