Skip to content

Preview AI Agent Instructions

POST /aiagents/preview-instruction

Generate the instructions the submitted agent details produce, without creating an agent.

This is the same generation Create AI Agent performs when instructions are omitted or empty: the returned instructions can be reviewed, edited and posted back as the instructions field of a create or update request.

agent_name, agent_role, business_type, business_name and business_description are required. greeting is optional. custom_agent_role and custom_business_type are required when the matching field is set to other.

voice and instructions are not read by the generator: they are not required and are ignored.