API Quickstart

Get started with the Asteroid API and SDKs

Use this page as the starting point for programmatic access to Asteroid.

This API section contains the current OpenAPI schema. Some SDK helpers still rely on legacy endpoints for profile management and execution result helpers, so you may see older routes referenced in some examples.

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.

   
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:

     export ASTEROID_API_KEY="your-key-here"
   
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.

   TypeScript

   import { AsteroidClient, executeAgent, waitForExecutionResult } from 'asteroid-odyssey';
   
   const client = AsteroidClient(process.env.ASTEROID_API_KEY!);
   
   const executionId = await executeAgent(client, 'your-agent-id', {
     dynamicData: {
       customerName: 'Jane Doe',
     },
   });
   
   const result = await waitForExecutionResult(client, executionId);
   console.log(result);
   

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 [e-mail]