API documentation

GET /api/v1/voice_agent_flows
List all AI Flows for the authenticated company.

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id context_menu_name company_id voice_agent_id name description sortable_order conversation_timeout execution_mode voice_agent_field_ids action_type forward_to_offer_id forward_to_buyer_id voice_agent_keywords_count reasoning_effort greeting record_token_filter_id record_token_filter_data_count record_token_filter_data record_token_additional_id record_token_additional_data_count record_token_additional_data Validations: Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/voice_agent_flows/new
Return a new AI Flow object pre-populated with default values (not persisted).

Params

Param name	Description Validations
voice_agent_id Optional	Voice Agent – ID of the AI Agent that owns this Flow. Validations: Must be a valid foreign key reference to an Voice Agent. Refer to: /api/docs/1.0/voice_agents
execution_mode Optional	Execution Mode – Defines how the Flow executes. 'agent' runs an AI-driven interview. 'action' performs an immediate call-routing or end-call action without further AI interaction. Validations: Must be one of: `agent`, `action`.
action_type Optional	Action Type – Specifies the routing action when execution_mode is 'action'. For example: redirect, forward_to_buyer, block_caller, end_call. Validations: Must be one of: `redirect`, `forward`, `block_caller`, `end_call`.
prompt Optional	Prompt – System instructions or context specific to this Flow. Can include rules, validation criteria, or conversation style guidance. Validations: Must be a String
greeting Optional Blank Value Allowed	Greeting – Optional opening line spoken to the caller at the start of this Flow before any questions are asked. Validations: Must be a String
description Optional Blank Value Allowed	Description – Short summary describing the purpose of this Flow. Validations: Must be a String
conversation_timeout Optional Blank Value Allowed	Conversation Timeout – Per-prompt timeout (in seconds) before the Flow fails if no response is received. Overrides the AI Agent’s default if set. Validations: Must be a decimal number.
contact_field_ids Optional Blank Value Allowed	Translation missing: en.api.voice_agent_flows.contact_field_ids Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Contact Field. Refer to: /api/docs/1.0/contact_fields
forward_to_offer_id Optional Blank Value Allowed	Forward To Offer – ID of the offer to forward the call to if action_type is 'redirect'. Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
forward_to_buyer_id Optional Blank Value Allowed	Forward To Buyer – ID of the buyer or destination DID to forward to if action_type is 'forward_to_buyer'. Validations: Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

POST /api/v1/voice_agent_flows
Create a new AI Flow with the provided attributes.

Params

Param name	Description Validations
voice_agent_id Optional	Voice Agent – ID of the AI Agent that owns this Flow. Validations: Must be a valid foreign key reference to an Voice Agent. Refer to: /api/docs/1.0/voice_agents
execution_mode Optional	Execution Mode – Defines how the Flow executes. 'agent' runs an AI-driven interview. 'action' performs an immediate call-routing or end-call action without further AI interaction. Validations: Must be one of: `agent`, `action`.
action_type Optional	Action Type – Specifies the routing action when execution_mode is 'action'. For example: redirect, forward_to_buyer, block_caller, end_call. Validations: Must be one of: `redirect`, `forward`, `block_caller`, `end_call`.
prompt Optional	Prompt – System instructions or context specific to this Flow. Can include rules, validation criteria, or conversation style guidance. Validations: Must be a String
greeting Optional Blank Value Allowed	Greeting – Optional opening line spoken to the caller at the start of this Flow before any questions are asked. Validations: Must be a String
description Optional Blank Value Allowed	Description – Short summary describing the purpose of this Flow. Validations: Must be a String
conversation_timeout Optional Blank Value Allowed	Conversation Timeout – Per-prompt timeout (in seconds) before the Flow fails if no response is received. Overrides the AI Agent’s default if set. Validations: Must be a decimal number.
contact_field_ids Optional Blank Value Allowed	Translation missing: en.api.voice_agent_flows.contact_field_ids Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Contact Field. Refer to: /api/docs/1.0/contact_fields
forward_to_offer_id Optional Blank Value Allowed	Forward To Offer – ID of the offer to forward the call to if action_type is 'redirect'. Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
forward_to_buyer_id Optional Blank Value Allowed	Forward To Buyer – ID of the buyer or destination DID to forward to if action_type is 'forward_to_buyer'. Validations: Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

GET /api/v1/voice_agent_flows/:id
Retrieve a single AI Flow by its unique ID.

PUT /api/v1/voice_agent_flows/:id
Update an existing AI Flow by its unique ID.

Params

Param name	Description Validations
voice_agent_id Optional	Voice Agent – ID of the AI Agent that owns this Flow. Validations: Must be a valid foreign key reference to an Voice Agent. Refer to: /api/docs/1.0/voice_agents
execution_mode Optional	Execution Mode – Defines how the Flow executes. 'agent' runs an AI-driven interview. 'action' performs an immediate call-routing or end-call action without further AI interaction. Validations: Must be one of: `agent`, `action`.
action_type Optional	Action Type – Specifies the routing action when execution_mode is 'action'. For example: redirect, forward_to_buyer, block_caller, end_call. Validations: Must be one of: `redirect`, `forward`, `block_caller`, `end_call`.
prompt Optional	Prompt – System instructions or context specific to this Flow. Can include rules, validation criteria, or conversation style guidance. Validations: Must be a String
greeting Optional Blank Value Allowed	Greeting – Optional opening line spoken to the caller at the start of this Flow before any questions are asked. Validations: Must be a String
description Optional Blank Value Allowed	Description – Short summary describing the purpose of this Flow. Validations: Must be a String
conversation_timeout Optional Blank Value Allowed	Conversation Timeout – Per-prompt timeout (in seconds) before the Flow fails if no response is received. Overrides the AI Agent’s default if set. Validations: Must be a decimal number.
contact_field_ids Optional Blank Value Allowed	Translation missing: en.api.voice_agent_flows.contact_field_ids Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Contact Field. Refer to: /api/docs/1.0/contact_fields
forward_to_offer_id Optional Blank Value Allowed	Forward To Offer – ID of the offer to forward the call to if action_type is 'redirect'. Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
forward_to_buyer_id Optional Blank Value Allowed	Forward To Buyer – ID of the buyer or destination DID to forward to if action_type is 'forward_to_buyer'. Validations: Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

DELETE /api/v1/voice_agent_flows/:id
Delete an AI Flow by its unique ID. This will soft-delete the record unless permanently removed.