agent_name, voice and business_description are required on create and must remain populated on update. instructions may be omitted or empty on create, when AVANSER generates them, but the configured instructions cannot be cleared on update.
business_description is also required when previewing instructions. Every other agent detail is optional, unless the instructions are left to AVANSER to generate: the fields the generator reads are then required as well.
| field | required |
|---|---|
agent_role | when the instructions are generated |
custom_agent_role | when the instructions are generated and agent_role is other |
business_type | when the instructions are generated |
custom_business_type | when the instructions are generated and business_type is other |
business_name | when the instructions are generated |
Instructions are only generated by Create AI Agent and Preview AI Agent Instructions, so these five fields are required for generation only. Update AI Agent never generates instructions, but requires the existing or submitted instructions to remain populated. On update, custom_agent_role and custom_business_type are also required when the resulting role or business type is other.
contact_email, when submitted, must be a valid email address, and instructions cannot exceed 4000 characters.
agent_id, in the requests taking one, accepts letters, digits, - and _ only, any other value fails the request with agent_id: invalid.