Skip to main content
Use this page as the starting point for programmatic access to Asteroid.
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

Our examples use ASTEROID_API_KEY as a convenient environment variable. Set it once and read it from your own code:
4

Choose how you want to integrate

Pick the starting point that matches your workflow:
  • TypeScript SDK for the high-level helper client and generated namespaces
  • Python SDK for the high-level client and generated subpackages
  • API for the main API landing page and common workflows
The reference pages in this section are the best place to inspect individual request and response schemas.
5

Run your first execution

Use one of the SDK guides above, or start from the minimal examples below.
API-triggered executions run the agent’s latest published version — edits saved as a draft in the Builder don’t apply until you publish. See Versions & Publishing.

Next Steps

Once you’ve set up your environment, you can:
  1. Inspect the endpoint reference pages in this API section for request and response details
  2. Follow the TypeScript SDK or Python SDK guides for end-to-end examples
  3. Review Agent Profiles if you need persistent browser state, credentials, or proxies
Need help? Contact us at [email protected]