Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

README.md

Minimal Example

Basic interactive streaming example with OpenCV display.

Setup

  1. Install the example dependencies:
cd interactive-client/python
uv sync --extra examples
  1. Configure your API key (choose one method):
# Option A: Create a .env.local file (recommended)
echo 'ODYSSEY_API_KEY=ody_your_key_here' > .env.local

# Option B: Export environment variable
export ODYSSEY_API_KEY="ody_your_api_key_here"

Usage

# Run with defaults
uv run python examples/minimal/main.py

# Custom prompts
uv run python examples/minimal/main.py --prompt "A dog" --interaction "The dog barks"

# Enable debug logging
uv run python examples/minimal/main.py --debug

Note: This example requires a display (uses OpenCV GUI).

Keyboard Controls

Key Action
c Connect to Odyssey
s Start stream
i Send interaction
e End stream
d Disconnect
p Toggle portrait/landscape
q Quit

Options

Option Default Description
--prompt "A cat" Prompt for video generation
--interaction "Pet the cat" Prompt for interactions
--debug false Enable debug logging