Cloudflare Structured Output

Generate JSON with Cloudflare Workers AI and validate it locally as a MovieScript.

The current Agno Cloudflare adapter uses AI Gateway's /compat/chat/completions endpoint. Cloudflare deprecates this endpoint for single-model calls while keeping it working for existing integrations. Dynamic routes still require it. For new direct model integrations, follow Cloudflare's current REST API guide.

structured_output.py
"""
Cloudflare Structured Output
============================

Cookbook example for `cloudflare/structured_output.py`.
"""

from typing import List

from agno.agent import Agent, RunOutput  # noqa
from agno.models.cloudflare import Cloudflare
from pydantic import BaseModel, Field
from rich.pretty import pprint  # noqa

# ---------------------------------------------------------------------------
# Create Agent
# ---------------------------------------------------------------------------


class MovieScript(BaseModel):
    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.",
    )
    name: str = Field(..., description="Give a name to this movie")
    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 uses JSON mode
json_mode_agent = Agent(
    model=Cloudflare(id="@cf/google/gemma-4-26b-a4b-it"),
    description="You write movie scripts.",
    output_schema=MovieScript,
    use_json_mode=True,
)

# Agent that uses structured outputs
structured_output_agent = Agent(
    model=Cloudflare(id="@cf/google/gemma-4-26b-a4b-it"),
    description="You write movie scripts.",
    output_schema=MovieScript,
)

# Get the response in a variable
# json_mode_response: RunOutput = json_mode_agent.run("New York")
# pprint(json_mode_response.content)
# structured_output_response: RunOutput = structured_output_agent.run("New York")
# pprint(structured_output_response.content)

json_mode_agent.print_response("New York")
structured_output_agent.print_response("New York")

# ---------------------------------------------------------------------------
# Run Agent
# ---------------------------------------------------------------------------

if __name__ == "__main__":
    pass

The first agent requests JSON Object mode. The second sends a JSON Schema request derived from MovieScript. The selected Workers AI model must support the requested output format; Agno also validates the returned content locally.

output_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/activate

Install dependencies

uv pip install -U agno openai

Set up Cloudflare access

Use a Cloudflare account and an API token with the permissions required for AI Gateway and Workers AI. The default gateway is created on the first request; set CLOUDFLARE_AI_GATEWAY_ID only to use another existing gateway.

export CLOUDFLARE_ACCOUNT_ID="your_cloudflare_account_id_here"
export CLOUDFLARE_API_TOKEN="your_cloudflare_api_token_here"

Workers AI examples use this Cloudflare token. Other providers can require stored provider keys or supported unified billing; configure the selected route in the gateway before switching to it.

Run the example

Save the code above as structured_output.py, then run:

python structured_output.py

Full source: cookbook/90_models/cloudflare/structured_output.py