Response Format Examples for Custom Connections
Use these examples as starting points when you design AiResponseFormat entries for your own custom connection. To reference an AiResponseFormat from your AiSurface see, Set Up a Custom Connection.
For background on how the agent selects a response format and why client-side validation matters, see Custom Connections.
Use this format when you want to present the user with a short list of text-only options, such as a menu or a disambiguation prompt.
Use this format when the user is selecting from a collection of items where an image is essential to the decision—product listings, location cards, or avatar pickers.
Use this format when you need the user to pick a specific time. The schema below follows Slack Block Kit timepicker syntax, which is a useful reference if your client already renders Block Kit components.
The time picker schema expects the agent to produce output in this format:
- Keep the set small. We recommend fewer than 7 response formats per connection. Too many formats make it harder for the agent to reliably pick the right one.
- Write the
descriptionfor selection, not for humans. The agent uses thedescriptionandinstructionsto decide whether a format applies. Spell out the exact conditions—number of items, presence of images, data shape—in natural language. - Generate the JSON schema with an LLM. Provide your preferred LLM with the output structure your client expects and ask it to generate the corresponding JSON schema.