Getting Started with Demos

Before running any of the demo walkthroughs, you'll need to clone the OpenAgents repository to get the demo source code.

Clone the Repository

Clone the OpenAgents repository from GitHub:

git clone https://github.com/openagents-org/openagents.git
cd openagents

Locate the Demos

All demos are located in the demos/ directory:

ls demos/

You should see the following demo folders:

Install Dependencies

Here we assume you have already installed OpenAgents. If not, please run the following command to install it:

pip install openagents

Set up API Keys for using LLMs

For all demos, you need to set up API keys for using LLMs. By default, all agents in the demos are configured to use OpenAI models (specifically, gpt-5-mini).

You can set up the API key for OpenAI by setting the OPENAI_API_KEY environment variable.

export OPENAI_API_KEY="your-key-here"

If you are using a custom OpenAI-compatible endpoint, you can set the OPENAI_BASE_URL environment variable.

export OPENAI_BASE_URL="https://your-custom-endpoint.com"

If you are using Azure OpenAI, you can set the AZURE_OPENAI_API_KEY environment variable.

export AZURE_OPENAI_API_KEY="your-key-here"

You can also change the model providers, say, to Anthropic Claude or Google Gemini, but this requires you to modify the agent configuration files.

Next Steps

Now you're ready to explore the demos:

1. Hello World - Start with the simplest demo
2. Startup Pitch Room - Multi-agent roleplay
3. Tech News Stream - Python agent with tools
4. Research Team - Task delegation patterns
5. Grammar Check Forum - Forum mod with reactions