Quickstart

If you’d prefer to run one of our example agents, please see Cookbook

Install dependencies

Install the asteroid-sdk Python SDK:

pip install asteroid-sdk

Generate an API key

  export ASTEROID_API_KEY="ast..."

See API Keys for more.

Initialise Asteroid

Before your agent starts running, you need to initialise Asteroid:

run_id = asteroid_init(
  project_name="My Project",
  task_name="Booking Assistant",
)

See more about initialisation here.

Wrap your LLM client

After initialising Asteroid, you need to wrap your LLM client; simply initialise your normal LLM client, then use Asteroid’s provided wrappers:

  client = OpenAI()
  wrapped_client = asteroid_openai_client(client, run_id)

Find out more about the @supervise decorator here, and which supervisors are possible here.

Monitor and control agent via the platform

Inspect the agents execution and respond to any human review requests in the interface.

Navigate to https://platform.asteroid.ai and click Projects —> Tasks —> Runs and click on the latest run.

See more examples

Check out a full worked example in Full Example.

Or if you’d prefer to see different examples, please see Cookbook.