structured_output.py
"""
Aimlapi Structured Output
=========================
Cookbook example for `aimlapi/structured_output.py`.
"""
from typing import List
from agno.agent import Agent, RunOutput # noqa
from agno.models.aimlapi import AIMLAPI
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!"
)
json_mode_agent = Agent(
model=AIMLAPI(id="gpt-5.2"),
description="You help people write movie scripts.",
output_schema=MovieScript,
use_json_mode=True,
)
# Get the response in a variable
json_mode_response: RunOutput = json_mode_agent.run("New York")
pprint(json_mode_response.content)
# json_mode_agent.print_response("New York")
# ---------------------------------------------------------------------------
# Run Agent
# ---------------------------------------------------------------------------
if __name__ == "__main__":
pass
Run the Example
1
Set up your virtual environment
uv venv --python 3.12
source .venv/bin/activate
uv venv --python 3.12
.venv\Scripts\activate
2
Install dependencies
uv pip install -U agno openai
3
Export your AI/ML API API key
export AIMLAPI_API_KEY="your_aimlapi_api_key_here"
$Env:AIMLAPI_API_KEY="your_aimlapi_api_key_here"
4
Run the example
Save the code above as
structured_output.py, then run:python structured_output.py