Make an agent answer in a fixed format

Purpose

Kian's order script needs an answer it can read the same way every time, not a paragraph of prose. Require the agent's final answer to follow a JSON Schema, so other programs can rely on its shape.

Before you start

The custom agent must belong to your current workspace, you need permission to manage agents, and you must know the JSON Schema you want. The chosen model must support structured answers.

Steps

1. Open "Agents", find your agent under "My agents" and select it. In the window, open "Agent actions" (the three dots) and choose "Edit agent".
2. Open "Structured output" and turn it on. While it is off, the fields cannot be edited.
3. Under "Format details", enter a "Schema name" (start with an English letter; then use English letters, digits, underscores or hyphens; up to 64 characters) and a "Schema description" (up to 500 characters).
4. Under "Response format", edit the "JSON Schema". The root must be an object with a "properties" object, and every property needs a type: object, array, string, number, integer, boolean or null. Names in "required" must exist in "properties", arrays need "items" and an "enum" cannot be empty.
5. Read the message under the editor. It confirms that the schema is valid (the server checks it again when you save) or describes the problem. Syntax errors may identify a line and column; schema errors identify the invalid requirement or field. "Format JSON" tidies a valid schema and does nothing for an invalid one.
6. Select "Save".

Expected result

The agent's final answer follows the schema. The schema does not give the agent new tools.

Troubleshooting