Setup

Install an Asteroid SDK and point it at your workflow

Both SDKs are called asteroid-odyssey. They wrap the same REST API, so anything one can do the other can too.

1. Generate an API key

   Sign in to our platform, click your profile picture at the bottom left, then API Keys. Or go straight to platform.asteroid.ai/keys.

   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.

2. Install

   TypeScript

   npm install asteroid-odyssey
   
3. Run your workflow

   Deploy a workflow has the working end-to-end example in both languages: execute, poll to a terminal status, and read the result.

   The pages below cover what is specific to each SDK — client configuration, the function and class surface, and the naming conventions.

TypeScript SDK

The client singleton and its endpoint functions

Python SDK

Configuration, ApiClient, and the generated API classes

Need help? Reference our Support page