Keys and authentication

Voxio has two kinds of key. Flow keys are public: they go in web pages. The account key is secret: it stays on your server.

#Key types

#Use a flow key in the browser

Widgets and browser sessions take the flow key as flowKey. Anyone who opens your page can read it, like a public API key for maps or analytics. It can only start conversations with that flow and read its sessions; it can't change the flow.

Pass the flow key when you create a session:

1import { createSession } from "voxioagent/client";
2
3const session = createSession({ flowKey: "YOUR_FLOW_KEY" });

Replace YOUR_FLOW_KEY with your flow key, from the flow's Overview in the dashboard.

#Keep the account key on your server

Store the account key in an environment variable:

1export VOXIO_SECRET_KEY="ACCOUNT_KEY"

Replace ACCOUNT_KEY with your account key, from Developers.

Then read it on your server when you create the client:

1import { Voxio } from "voxioagent/server";
2
3const voxio = new Voxio({ secretKey: process.env.VOXIO_SECRET_KEY, environment: "gpu" });

voxioagent/server refuses to run in a browser, so the account key can't end up in a page by accident.

#Rotate a key

If a key leaks, replace it. The old key stops working at once, and calls already running carry on until they end.

• To rotate the account key, go to Developers and click Rotate.
• To rotate a flow key, open the flow's Overview and click Rotate.

To rotate a flow key from your server, call rotateKey:

1const { flowKey: newKey } = await voxio.flows.rotateKey("OLD_FLOW_KEY");

Replace OLD_FLOW_KEY with the key to replace.

Update every page and server that used the old key.

#Accounts

Create accounts at voxio.in/signup and sign in at voxio.in/login. Each account gets its account key when it's created, and flows you make in the dashboard are ready for the voice servers straight away. There's no API for creating accounts or signing in.

#Next steps

• Server SDK: set up voxioagent/server with your account key.
• Servers and environments: choose which Voxio servers your code talks to.