Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.asteroid.ai/llms.txt

Use this file to discover all available pages before exploring further.

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:
  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.
import { client, agentExecutePost, executionGet } from 'asteroid-odyssey';

client.setConfig({
  headers: { 'X-Asteroid-Agents-Api-Key': process.env.ASTEROID_API_KEY! },
});

const { data, error } = await agentExecutePost({
  path: { agentId: 'your-agent-id' },
  body: {
    inputs: { customerName: 'Jane Doe' },
  },
});
if (error) throw new Error(JSON.stringify(error));
const executionId = data.executionId;

let exec;
do {
  await new Promise((r) => setTimeout(r, 3000));
  const res = await executionGet({ path: { executionId } });
  exec = res.data;
} while (exec?.status === 'running' || exec?.status === 'starting');

console.log(exec?.status);

​
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]