The easiest way to get started is to head to our platform and run an agent from there: https://platform.asteroid.ai If you want to run an agent from your own code, you can follow the steps below to obtain your Asteroid API key and gain full access to the platform.
1

Sign up for Asteroid

Follow the instructions here to sign up for the Asteroid platform: Asteroid signup using your Google account.
2

Get your API key

Once you have signed up, you can retrieve your API key from the API keys page. Get your API key
3

Set your environment variable

The Asteroid SDK will look for the Asteroid API key in the ASTEROID_API_KEY environment variable. To set it:
  export ASTEROID_API_KEY="your-key-here"
4

Choose your SDK

We provide SDKs for both TypeScript and Python. Choose the one that best fits your needs:Each SDK page contains detailed documentation and examples to help you get started.

​
Next Steps

Once you’ve set up your environment, you can:
  1. Create your first workflow using the platform UI
  2. Follow the examples in the SDK documentation
Need help? Contact us at [email protected]