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

Voice Agent – ID of the AI Agent that owns this Flow.

• Must be a valid foreign key reference to an Voice Agent. Refer to: /api/docs/1.0/voice_agents

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.

• Must be one of: agent, action.

Action Type – Specifies the routing action when execution_mode is 'action'. For example: redirect, forward_to_buyer, block_caller, end_call.

• Must be one of: redirect, forward, block_caller, end_call.

Prompt – System instructions or context specific to this Flow. Can include rules, validation criteria, or conversation style guidance.

• Must be a String

Greeting – Optional opening line spoken to the caller at the start of this Flow before any questions are asked.

• Must be a String

Description – Short summary describing the purpose of this Flow.

• Must be a String

Conversation Timeout – Per-prompt timeout (in seconds) before the Flow fails if no response is received. Overrides the AI Agent’s default if set.

• Must be a decimal number.

Translation missing: en.api.voice_agent_flows.contact_field_ids

• 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 of the offer to forward the call to if action_type is 'redirect'.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Forward To Buyer – ID of the buyer or destination DID to forward to if action_type is 'forward_to_buyer'.

• Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers