xAI Structured Output
Request JSON and validate a MovieScript with Pydantic through Grok 4.3.
This example sends a JSON Schema request and validates the returned content locally. Check the selected model and server support before running.
"""
Xai Structured Output
=====================
Cookbook example for `xai/structured_output.py`.
"""
from typing import List
from agno.agent import Agent
from agno.models.xai.xai import xAI
from agno.run.agent import RunOutput
from pydantic import BaseModel, Field
from rich.pretty import pprint # noqa
# ---------------------------------------------------------------------------
# Create Agent
# ---------------------------------------------------------------------------
class MovieScript(BaseModel):
name: str = Field(..., description="Give a name to this movie")
setting: str = Field(
..., description="Provide a nice setting for a blockbuster movie."
)
ending: str = Field(
...,
description="Ending of the movie. If not available, provide a happy ending.",
)
genre: str = Field(
...,
description="Genre of the movie. If not available, select action, thriller or romantic comedy.",
)
characters: List[str] = Field(..., description="Name of characters for this movie.")
storyline: str = Field(
..., description="3 sentence storyline for the movie. Make it exciting!"
)
# Agent that returns a structured output
structured_output_agent = Agent(
model=xAI(id="grok-2-latest"),
description="You write movie scripts.",
output_schema=MovieScript,
)
# Run the agent synchronously
structured_output_response: RunOutput = structured_output_agent.run(
"Llamas ruling the world"
)
pprint(structured_output_response.content)
# ---------------------------------------------------------------------------
# Run Agent
# ---------------------------------------------------------------------------
if __name__ == "__main__":
passoutput_schema describes the expected type. If parsing or validation fails, result.content can remain a string. Before accessing schema fields in a run result, use isinstance(result.content, YourSchema), replacing YourSchema with the class you passed as output_schema.
Run the Example
Set up your virtual environment
uv venv --python 3.12
source .venv/bin/activateInstall dependencies
uv pip install -U agno openaiExport your xAI API key
export XAI_API_KEY="your_xai_api_key_here"Select the current Grok model
Replace id="grok-2-latest" with id="grok-4.3" in the saved constructor. Grok 4.3 supports function calling and structured output; use an API key with access to this model.
Run the example
Save the code above as structured_output.py, then run:
python structured_output.pyFull source: cookbook/90_models/xai/structured_output.py