Start

Getting started

Base URL, keys and your first call.

The VoiFlow API lets a partner backend create businesses, set up agents, start calls, read transcripts and receive webhooks. It is a JSON API over HTTPS.

Base URLhttps://api.voiflow.ai/v1
AuthenticationAuthorization: Bearer vf_test_… or vf_live_…
KeysCreated in the Partner Portal, under Developers

Your first request

Create a key in the Partner Portal under Developers. A vf_test_ key works on test data and never places a real call or touches a live business. List the businesses it can act for:

List businesses
const client = new VoiFlowClient({ apiKey: process.env.VOIFLOW_API_KEY! });

for await (const business of client.businesses.list()) console.log(business.id, business.name);

Start a call

Starting a call is accepted straight away and connects afterwards: the response is a 202 with the call in status starting. Follow it through the event stream or a webhook.

Start a call
const client = new VoiFlowClient({ apiKey: process.env.VOIFLOW_API_KEY! });

const call = await client.calls.create(
  { agent_id: "agent_id", contact_id: "contact_id", mission: "Confirm tomorrow's visit" },
  { businessId: "business_id" }, // only needed if your key covers more than one business
);
console.log(call.call_id, call.status); // "starting": the call is accepted, not yet connected

Where to next