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 OptionalBlank 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 OptionalBlank Value Allowed |
Description – Short summary describing the purpose of this Flow. Validations: - Must be a String |
| conversation_timeout OptionalBlank 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 OptionalBlank 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 OptionalBlank 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 OptionalBlank 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 |