Skip to main content
POST
Create Call Flow

Headers

string
required
API key used for authenticating requests to the API.
string
required
Workspace identifier for the API.

Request Body

string
required
A friendly name for this call flow (e.g., “Customer Support Flow”).
string
required
Direction of the flow. Possible values: “outbound”, “bidirectional”.
string
Description of the call flow (e.g. “Handles inbound support calls”).
string
ID of the agent to associate with this flow. If provided, the system looks for a pending phone number for that agent and activates it.
string
default:"simple"
required
Only “simple” type of prompt configuration is allowed now.
string
ID of the folder to organize this call flow.
boolean
Whether this is a global call flow. Only specific workspaces can create global flows.
boolean
Whether this call flow is pre-configured. Defaults to false.
string
Workspace ID for pre-configured flows.
string
Welcome message type. Possible values: “user_initiated”, “ai_dynamic”, “ai_custom”. Defaults to “user_initiated”.
string
Custom welcome message text when welcomeMessage is set to “ai_custom” only.
object
Flow-based configuration using a node/edge approach for complex call routing.
string
A system or initial prompt for the flow. This will be used to create the first prompt version.
boolean
Whether the flow is currently active. Defaults to true.
string
Webhook URL for agent-related events.
string
Webhook URL for inbound call events.
array
Array of dynamic variable collections for the call flow.
array
Array of webhook configurations for the call flow.
object
Main configuration object for the call flow.

Response Fields

string
The unique identifier for the newly created call flow.
string
The identifier of the workspace where the call flow has been created.
string
The identifier of the folder where the call flow is organized.
boolean
Whether this is a global call flow.
boolean
Whether this call flow is pre-configured.
string
Workspace ID for pre-configured flows.
string
The name given to the call flow.
string
The direction configuration of the call flow; can be “inbound”, “outbound”, or “bidirectional”.
string
A description of what the call flow is designed to handle.
string
The identifier of the agent associated with this call flow.
string
default:"simple"
Only “simple” prompt types allowed now.
string
Welcome message type configuration.
string
Custom welcome message text if configured.
object
The configuration of nodes and edges that define the call routing logic within the flow.
array
Detailed configuration of the nodes within the call flow.
array
Configurations of the edges connecting nodes within the call flow.
string
The initial or system prompt used in the call flow.
string
ID of the current active prompt version.
array
Array of prompt versions with their metadata.
string
Unique identifier for the prompt version.
string
Name of the prompt version.
string
Prompt content for this version.
object
Additional metadata including notes.
string
Sanitized version of the prompt for Gemini processing.
boolean
Indicates whether the call flow is currently active or inactive.
string
Webhook URL for agent-related events.
string
Webhook URL for inbound call events.
array
Array of dynamic variable collections configured for the call flow.
array
Array of location objects for visual flow positioning.
array
Array of configured webhooks with their complete configuration.
object
Configuration settings for various aspects of the call flow, including welcome messages, webhooks, knowledge bases, call settings, and security.
object
Security settings with processed values.
boolean
HIPAA compliance status (processed from securityOptOut).
boolean
Public access configuration.
string
Timestamp when the call flow was created.
string
Timestamp when the call flow was last updated.