Voice Flows

Voice flows define the AI conversation configuration used in campaigns.

Flows are managed through the UI dashboard. The API provides read-only access to list and retrieve flows for use when creating campaigns.

The Flow Object

{
  "id": "flow_xyz789",
  "name": "Hindi Customer Survey - Q1",
  "type": "SURVEY",
  "language": "hi-IN",
  "voiceGender": "FEMALE",
  "ttsProvider": "GOOGLE",
  "llmProvider": "GEMINI_API",
  "systemInstruction": "You are Priya...",
  "initialPrompt": "Namaste! Main Priya bol rahi hoon...",
  "allowInterrupts": true,
  "organizationId": "org_1",
  "createdAt": "2026-02-01T12:00:00.000Z",
  "updatedAt": "2026-03-01T09:00:00.000Z"
}

Flow Types

Type	Description
`SURVEY`	Collect structured responses
`MASS_COMMUNICATION`	Broadcast information
`NUDGE`	Behavioral nudge or reminder
`HYBRID`	Combined communication and collection

TTS Providers

Value	Description
`GOOGLE`	Google Cloud TTS — best for Indian languages
`GEMINI`	Gemini TTS — more natural conversation
`ELEVENLABS`	ElevenLabs — premium neural voices

LLM Providers

Value	Description
`GEMINI_API`	Google Gemini API
`OLIAI_INFERENCE`	Self-hosted Gemma (OliAI private inference)

List Flows

GET /v1/flows

Response:

{
  "data": [/* Flow objects */],
  "total": 8,
  "page": 1,
  "limit": 20
}

Get a Flow

GET /v1/flows/:id

Response: A single Flow object.

Campaigns Imports