Upsert
Authentication
Query parameters
Request
The background noise type. Can be “office”, “call-center”, “coffee-shop”, or null.
When not null, at the beginning of the conversation the agent will make a POST request to this endpoint when to get configuration options.
Array of custom phone numbers in E.164 format (e.g., [“+1234567890”, “+0987654321”]). The agent will be able to receive phone calls on any of these numbers. Required when phone_number is set to "custom". All phone numbers must be unique.
When true, the welcome message will be automatically generated and the welcome_message field will be ignored.
Float between 0.0 and 1.0 representing the percentage of inbound calls handled by Agent. Defaults to 1.0. Requires phone_number to be set when less than 1.0.
E.164 formatted phone number where non-agent calls will be forwarded. Required when inbound_rollout < 1.0, must be null when inbound_rollout = 1.0. Defaults to null.
Array of ISO 639-1 language codes that the agent should be able to recognize
Number of seconds of silence before sending a poke message. null disables the poke message.
When set to null, the agent will not be associated with a phone number. When set to "assign-automatically", the agent will be assigned a random phone number. When set to "custom", you must provide custom_phone_numbers.
Instructions for the conversation. Can contain template variables like {{subject}}.
Array of task objects with name and description fields.
The timezone of the agent. Used to format system variables like {{system_time}}.
Array of built-in or custom tool names to use.
Message to play when the conversation starts. Can contain template variables like {{customer_name}}. Ignored when generate_welcome_message is true.
The custom phone number to use for the agent in E.164 format (e.g., +1234567890). This field is deprecated. Use custom_phone_numbers instead.
