Cometapi Structured Output

Produce a MovieScript from CometAPI using output_schema with JSON mode.

structured_output.py

"""
Cometapi Structured Output
==========================

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

from typing import List

from agno.agent import Agent
from agno.models.cometapi import CometAPI
from pydantic import BaseModel, Field

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


class MovieScript(BaseModel):
    setting: str = Field(..., description="The setting of the movie")
    protagonist: str = Field(..., description="Name of the protagonist")
    antagonist: str = Field(..., description="Name of the antagonist")
    plot: str = Field(..., description="The plot of the movie")
    genre: str = Field(..., description="The genre of the movie")
    scenes: List[str] = Field(..., description="List of scenes in the movie")


agent = Agent(
    model=CometAPI(id="gpt-5.2"),
    description="You help people write movie scripts.",
    output_schema=MovieScript,
    use_json_mode=True,
    markdown=True,
)

agent.print_response("Generate a movie script about a time-traveling detective")

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

if __name__ == "__main__":
    pass

Run the Example

1. Set up your virtual environment

   Mac

   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 environment variables

   Mac/Linux

   export COMETAPI_KEY="your_cometapi_key_here"
   

   $Env:COMETAPI_KEY="your_cometapi_key_here"
   
4. Run the example

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

   python structured_output.py
   

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