Odyssey Python Examples

Example applications demonstrating the Odyssey Python client.

Setup

1. Install dependencies (from the interactive-client/python directory):

uv sync --extra examples

2. Set your API key:

# Option A: Environment variable
export ODYSSEY_API_KEY="ody_your_api_key_here"

# Option B: Create .env.local in the example directory
echo 'ODYSSEY_API_KEY=ody_your_key_here' > .env.local

Examples

Example	Description
minimal	Basic interactive streaming with keyboard controls
i2v	Image-to-video streaming with OpenCV display
headless	Headless streaming - generate and save video to file
simulate	Async simulation jobs with YAML config
recordings	CLI for listing and downloading recordings

Quick Start

Interactive Streaming (with display)

# Minimal example with keyboard controls
uv run python examples/minimal/main.py

# Image-to-video
uv run python examples/i2v/main.py --image examples/assets/robot.jpg

Headless (no display required)

# Generate video and save to file
uv run python examples/headless/main.py --prompt "A cat sleeping" --output video.mp4

Async Simulation

# Submit a simulation job from YAML config
uv run python examples/simulate/main.py submit examples/simulate/examples/cat_nap.yaml

# Check job status
uv run python examples/simulate/main.py status <job_id>

# Wait for completion and download
uv run python examples/simulate/main.py wait <job_id> --output video.mp4

Recordings

# List your recordings
uv run python examples/recordings/main.py list

# Download a recording
uv run python examples/recordings/main.py download <stream_id> --output video.mp4

Requirements

• Python 3.12+
• OpenCV (for display examples)
• An Odyssey API key

Links

• API Reference
• Developer Docs
• Get an API Key