Setup

Hook your agent up to Asteroid in minutes

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:

1. Generate an API key

   Sign in to our platform, head to API Keys and generate a new key.

   export ASTEROID_API_KEY="ast..."
   

   Our SDK examples read from ASTEROID_API_KEY, but you can pass the value into your client however you prefer.

   See API Quickstart for more details.

2. Choose your SDK

   We provide SDKs for both TypeScript and Python.

   • TypeScript SDK
   • Python SDK

   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 agent using the platform UI
2. Follow the examples in the SDK documentation
3. Review the API page for common workflows and endpoint coverage

Need help? Reference our Support page