rising-crimson•4mo ago

VAPI Dashborad updated full documentation guide

Hello, everyone i am a dev, can anyone tell me where to find the VAPI Dashboard workflows full detailed documentation ?

20 Replies

You can find the full, updated documentation for VAPI Dashboard workflows at the official Vapi site: 👉 Vapi Workflows Documentation This page provides step-by-step guides, configuration details, and best practices for building and managing workflows in the dashboard. Bookmark this link for the latest updates and examples! Source: - Workflows documentation page

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

rising-crimsonOP•4mo ago

Ok thanks, but i didn't find how to make API calls from the workflows ? @Duckie

Vapi Support Bot•4mo ago

To make API calls from Vapi workflows, use the API Request node. Here’s how you can set it up: 1. Add an API Request node in your workflow. 2. Configure the URL, method (GET/POST), headers, and body as needed. 3. Define output variables to extract data from the API response. Example configuration:

{
  "url": "https://api.example.com/data",
  "method": "GET",
  "headers": [{ "key": "Authorization", "value": "Bearer YOUR_TOKEN" }],
  "output": { "key": "result", "target": "api_result", "type": "string" }
}

{
  "url": "https://api.example.com/data",
  "method": "GET",
  "headers": [{ "key": "Authorization", "value": "Bearer YOUR_TOKEN" }],
  "output": { "key": "result", "target": "api_result", "type": "string" }
}

See the API Request node documentation for more details. Source: - API Request node documentation

rising-crimsonOP•4mo ago

@Duckie your provided links says not found

Vapi Support Bot•4mo ago

It looks like the direct link to the API Request node documentation is currently broken, but you can still add API calls in your workflow using the API Request node. Here’s a quick example of how to configure it:

{
  "url": "https://api.example.com/data",
  "method": "GET",
  "headers": [{ "key": "Authorization", "value": "Bearer YOUR_TOKEN" }],
  "output": { "key": "result", "target": "api_result", "type": "string" }
}

{
  "url": "https://api.example.com/data",
  "method": "GET",
  "headers": [{ "key": "Authorization", "value": "Bearer YOUR_TOKEN" }],
  "output": { "key": "result", "target": "api_result", "type": "string" }
}

For more details and step-by-step guidance, check the main Vapi Workflows documentation. Source: - Vapi Workflows documentation

rising-crimsonOP•4mo ago

@Duckie { "url": "https://api.example.com/data", "method": "GET", "headers": [{ "key": "Authorization", "value": "Bearer YOUR_TOKEN" }], "output": { "key": "result", "target": "api_result", "type": "string" } } your this provided JSON code is not sufficient how to make api call from the vapi dashboard workflows

Vapi Support Bot•4mo ago

To make an API call from a Vapi workflow, add an API Request node and configure it like this:

{
  "url": "https://api.example.com/data",
  "method": "GET",
  "headers": [
    { "key": "Authorization", "value": "Bearer YOUR_TOKEN", "type": "string" }
  ],
  "output": [
    { "key": "name", "target": "user_name", "type": "string" },
    { "key": "age", "target": "user_age", "type": "number" }
  ]
}

{
  "url": "https://api.example.com/data",
  "method": "GET",
  "headers": [
    { "key": "Authorization", "value": "Bearer YOUR_TOKEN", "type": "string" }
  ],
  "output": [
    { "key": "name", "target": "user_name", "type": "string" },
    { "key": "age", "target": "user_age", "type": "number" }
  ]
}

This will extract name and age from the API response and make them available as variables in your workflow. For more details, see the Vapi Workflows documentation. Source: - Vapi Workflows documentation

rising-crimsonOP•4mo ago

@Duckie as you can see in the attached screenshot that their isn't any field for the output so how can i get the response of the api call ???

Vapi Support Bot•4mo ago

Thanks for sharing the screenshot!
According to the documentation, you should be able to define an output schema for the API Request node to extract response data as variables. However, since you don’t see an “output” field in the UI, could you check if there’s an “Advanced” or “Schema” section, or any expandable area in the node configuration where output mapping might be set? If not, please let me know if you see any other options related to response handling—this will help pinpoint if the feature is hidden, moved, or missing in your dashboard version. If you can share a screenshot of the full node configuration panel, that may also help clarify the situation. Sources: - API Request node documentation - Vapi Workflows documentation

deep-jade•4mo ago

https://docs.vapi.ai/workflows/quickstart

Workflows quickstart | Vapi

Build a simple agent that greets users and gathers basic information using Vapi workflows.

rising-crimsonOP•4mo ago

@Kings_big💫 suppose i make an api request with parameters how to get the output response of this api call ??

rising-crimsonOP•4mo ago

@Duckie
suppose i make an api request with parameters how to get the output response of this api call ??

Vapi Support Bot•4mo ago

To capture the API response in your Vapi workflow, you need to define an output schema in the API Request node.
Look for an "Output" or "Schema" section in the node configuration and add something like:

{
  "output": {
    "type": "object",
    "properties": {
      "name": { "type": "string", "target": "user_name" },
      "age": { "type": "number" }
    }
  }
}

{
  "output": {
    "type": "object",
    "properties": {
      "name": { "type": "string", "target": "user_name" },
      "age": { "type": "number" }
    }
  }
}

This will make user_name and age available as variables in the rest of your workflow. If you don't see an output/schema section, try expanding advanced or schema options in the node panel.
Reference: API Request node documentation Source: - API Request node documentation

deep-jade•4mo ago

Create a custom API tool in Vapi with your endpoint and parameters, add it to your assistant’s tools, have your server handle the API call and return a JSON response, which your assistant then processes and includes in replies..

rising-crimsonOP•4mo ago

@Kings_big💫 Ok now i created the tool for makien the api call and on n8n i am seding the response when i test the tool i am getting the output but here when i call the workflow and it hits the Call n8n tool it makes the api resposne but didn't call the output i am sening from the n8n how to capture this output.

deep-jade•4mo ago

End your n8n workflow with a “Respond to Webhook” node, ensure no “Wait” nodes are used, and make sure the webhook is actively listening..

rising-crimsonOP•4mo ago

@Kings_big💫 it's already set to the "Respond to webhook" and working fine when i test from the Tools tab but when i test the call from the workflow it call the tools function but din't speak the output

Sahil•4mo ago

Make sure your n8n workflow ends with the “Respond to Webhook” node placed last, avoid using any “Wait” nodes to prevent timeouts, confirm the webhook actively listens with an increased timeout if needed, and ensure the response format matches what Vapi expects then test with Postman to isolate if the issue is with n8n or VAPi..

rising-crimsonOP•4mo ago

thanks it's done now

Sahil•3mo ago

Glad the issue was resolved. Please reach out to us if you have any other questions regarding this issue

VAPI Dashborad updated full documentation guide

Did you find this page helpful?