Quick start

1. Create an account

Open the OrbitalsAI dashboard and create an account. No credit card is required to sign up.

2. Create an API key

Open API Keys, create a key, and copy it when it is shown. The full key is displayed once.

3. Install the Python SDK

pip install orbitalsai

4. Configure the API key

export ORBITALSAI_API_KEY="your_api_key"

Use a server-side environment variable or secret manager. Do not commit the key or place it in browser code.

5. Make your first request

Place a Hausa recording named audio.mp3 in the current directory, then run:

import os
import orbitalsai
 
client = orbitalsai.Client(
    api_key=os.environ["ORBITALSAI_API_KEY"]
)
 
transcript = client.transcribe(
    file_path="audio.mp3",
    language="hausa",
    model_name="Perigee-1-transcribe",
)
 
print(transcript.text)

client.transcribe() uploads the file, waits for the asynchronous job to complete, and returns a Transcript.

6. Inspect the result

To sai a gyara zama, don sauraron cikakkun labarai.

The text is available at transcript.text. Request generate_srt=True when you also need transcript.srt_content.

7. Choose the next step

Use backoff

Do not poll in a tight loop. Start with a short interval and increase it gradually for longer recordings.