noble-gold•17mo ago
Dialog API Project
Hello. I quite new one in voice flow, but Im more or less know how to build Dialog API Solution.
But how in the voicelow creator, prepare solution. I can see only webchat publishing, but how to publish when want to use as api service ?
5 Replies
To use Voiceflow as an API service, you'll be primarily working with the Dialog API. Here's a step-by-step guide on how to prepare your solution:
1. Create a Project: Start by creating a project in Voiceflow. This can be done from your workspace in Voiceflow. You can either use a template or create a project from scratch.
2. Design Your Agent: Use the Voiceflow design platform to build your AI agent. This is where you'll create the conversation logic for your agent.
3. Get API Key: Each agent in Voiceflow has its own API key, which you'll need to access the Dialog API. To get your API key, open your project and select the Integrations tab. From there, you can copy the API key.
4. Use Dialog API: The Dialog API allows you to integrate your agent with any custom channel or interface. You can use the API to manage the conversation state at runtime, offloading the work of managing dialog state machines to the designer.
5. Custom Launch: You can use the Dialog API to launch your agent to any channel. This gives you the flexibility to integrate your Voiceflow agent with an interface of your choice.
6. Publish: Voiceflow allows you to publish a version of your project to a production slot. This "freezes" a version of your project, so you have a stable copy to serve to your users. You can access this production version through the Dialog Manager API, by setting your versionID header to the string 'production'.
Remember, you can freely edit the diagram on canvas, without affecting the version that users see on your live application. If you want to update the production version, click the Publish button on the Voiceflow Creator again. This will replace the previous production version with the version displayed on your canvas.
For more detailed information, you can refer to the Voiceflow documentation and the Voiceflow API reference.
noble-goldOP•17mo ago
how to use dialog api to lunch my agent ?
blank-aquamarine•17mo ago
What are you trying to do exactly?
noble-goldOP•17mo ago
I would like to make SMS bot using twilio
blank-aquamarine•17mo ago
So once you publish, you have basically set you build live on the production version
Then all channels will use that, be it the webchat, or the dialog API
So no extra steps need to be done there
As for SMS, you can indeed hook something like twilio up and use the Dialog API
It's something we're also going to do for FlowBridge 🙂