Partner Portal · early access · v1 previewhttps://api.voiflow.ai/v1

Documentation for the VoiFlow API.

Start with the quickstart. Authentication, the full reference, webhooks, SDKs and error codes are unlocked for approved partners in the Developers area of the Partner Portal.

Quickstart Authentication API reference

Getting started

Base URL, test mode and your first call in three steps.

Early access · v1 preview

The VoiFlow API lets your software place and receive phone calls with an agent that talks, does the work and keeps the customer’s matter together across WhatsApp, SMS and email. It is JSON over HTTPS, with signed webhooks for everything that happens.

Base URL and versions

Every request goes to one base URL. Pin the version you built against with a header; the preview may change before general availability, and changes are listed in the changelog.

Base URL

https://api.voiflow.ai/v1

VoiFlow-Version: 2026-10-01

Quickstart

1
Get a sandbox key
Apply as a partner and choose API access. After approval, generate a key in the Developers area. Sandbox keys start with vf_test_ and place calls only to numbers you have verified, so nothing reaches a customer by accident.
2
Create and publish an agent
Give it instructions and the tools it may use. Publish it to your test line.
3
Place a call
Send one request. Your phone rings, the agent talks, and events stream to your webhook.

curl https://api.voiflow.ai/v1/calls \
  -H "Authorization: Bearer $VOIFLOW_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent": "front-desk",
    "to": "+971501234567",
    "goal": "Confirm the Saturday viewing and send the location pin",
    "context": {
      "customer": "Mr Khalid",
      "unit": "Creek Residences, 3-bed sea view"
    }
  }'

import VoiFlow from "voiflow";

const vf = new VoiFlow({ apiKey: process.env.VOIFLOW_KEY });

const call = await vf.calls.create({
  agent: "front-desk",
  to: "+971501234567",
  goal: "Confirm the Saturday viewing and send the location pin",
  context: {
    customer: "Mr Khalid",
    unit: "Creek Residences, 3-bed sea view",
  },
});

import os
from voiflow import VoiFlow

vf = VoiFlow(api_key=os.environ["VOIFLOW_KEY"])

call = vf.calls.create(
    agent="front-desk",
    to="+971501234567",
    goal="Confirm the Saturday viewing and send the location pin",
    context={
        "customer": "Mr Khalid",
        "unit": "Creek Residences, 3-bed sea view",
    },
)

The rest of the reference · approved builders

The full API reference lives in the Partner Portal.

Request access and we'll set you up with sandbox keys and the complete reference once you're approved.

Authentication Agents Calls Messages Journeys Campaigns Tasks Webhooks SDKs Errors Rate limits

Apply as a partner

Already approved? Sign in

Call it now · Malaysia line+60 3 2774 4929

Build it, then hear it.

Call the live agent yourself, then put your first request through. The same agent answers both.

Call Aina Start free Talk to sales