setting-up-vf-app.md

Setting up a Voiceflow App

---

To start using the SDK, we should build a General Project on Voiceflow. We have documentation available, so you can get ramped up quickly.

IMPORTANT: If you choose to build your own project, make sure you are building a General Project (anything that is not an Alexa Project nor a Google Project). The SDK only supports integration with Voiceflow General Projects out of the box.

1. Build a project on Voiceflow.

2. While you are on the Workspace Dashboard, click the settings icon in the top-right corner and open "Workspace Settings". NOTE: This will only be available to you if you are an admin of the Workspace.

3. Click "Developer" on the menu to get to the developer settings.

4. Click "Create New API Key" to generate an API Key. Copy the key, as you will need it later. NOTE: You should not save the key somewhere public. This key should be kept secret and supplied to your JavaScript codebase through environment variables.

5. Go back to your Dashboard.

6. Open the project you created earlier.

7. Click the Test button at the top-right corner to open up the Prototyping view.

8. Click Train Assistant on the sidebar in the Prototyping view. By now, you will have finished setting up the Voiceflow app. NOTE: If the "Train Assistant" button is not clickable, then your project does not need to be trained, so you can skip this step.

9. Copy the VERSION_ID from the URL in your address bar. When you are inside a Voiceflow project, your address bar should have a URL of the form: https://creator.voiceflow.com/project/{VERSION_ID}/.... You will need this VERSION_ID and the API key you copied earlier in Integration, Step-by-Step