Skip to content

Agent Options

List Agent Options returns the values accepted by the agent detail fields, as key/label lists:

option listagent detail field
voicesvoice
agentRolesagent_role
businessTypesbusiness_type
greetingStylesgreeting

The response also includes assistantTypes, personalAgentRoles and transferBehaviors for client interfaces. An option may include formFields, as other does for the custom role or business type.

Submit the option key, never its label. Where an option list offers the other key, instruction generation and update require the matching custom field: custom_agent_role for agent_role, custom_business_type for business_type.

The four lists are closed sets: a submitted value outside the keys below fails the request with invalid on that field, whether the instructions are generated or not. On update, the resulting voice is checked even when it was retained from the existing agent. The label column is what List Agent Options reports for display; the description column is a guide to picking between the closest keys.