We maintain a repository of example agents that use Asteroid for supervision. You can find them on our GitHub: https://github.com/asteroidai/cookbook.

To run an example, follow these simple steps:

1

Clone the Cookbook repo

  git clone https://github.com/asteroidai/cookbook
2

Pick an example

For example, you could pick the openai_tools_quickstart example:

  cd openai_quickstart
3

(Recommended) Create a new environment

For example, if you’re using Conda:

  conda create -n asteroid
  conda activate asteroid
4

Install requirements

  pip install -r requirements.txt
5

Get an API Key

Sign in https://platform.asteroid.ai and generate an API key, then set it with:

  export ASTEROID_API_KEY="your-key-here"

See API Keys for more information.

6

Run the example

  python run.py
7

(Optional) Check on your agent in the platform

Navigate to https://platform.asteroid.ai and find your agent in the interface

That’s it! You’ve now run an agent that uses Asteroid for supervision.

If you have any problems, please reach out to us at founders@asteroid.ai or join our Slack community.

Inspect Benchmarks