Documentation

Installation

Install the Aionvision Python SDK

Requirements

Python 3.9 or higher
pip package manager
An Aionvision API key

1. Get Your API Key

You need an API key to both install and use the SDK.

1. Sign up or log in at aionvision.tech

2. Navigate to Dashboard → API Keys

3. Click "Create API Key"

4. Copy your key (format: aion_...)

2. Install the SDK

Install the package using pip with your API key for authentication

pip install aion --extra-index-url https://aion:YOUR_API_KEY@api.aionvision.tech/api/v2/sdk/simple/

Replace YOUR_API_KEY with your actual API key from Step 1.

pip Configuration (Optional)

To avoid passing the URL every time, add it to your pip config:

# ~/.pip/pip.conf (Linux/macOS) or %APPDATA%\pip\pip.ini (Windows)
[global]
extra-index-url = https://aion:YOUR_API_KEY@api.aionvision.tech/api/v2/sdk/simple/

Then you can simply run pip install aion.

3. Set Up Environment Variable (Recommended)

Store your API key securely as an environment variable

# Linux/macOS
export AIONVISION_API_KEY="aion_your_key_here"

# Windows (PowerShell)
$env:AIONVISION_API_KEY="aion_your_key_here"

# Or add to your .env file
echo 'AIONVISION_API_KEY=aion_your_key_here' >> .env

4. Verify Installation

Test that everything is working

import asyncio
import os
from aion import AionVision

async def test_connection():
    api_key = os.environ.get("AIONVISION_API_KEY")

    async with AionVision(api_key=api_key) as client:
        # Check quota to verify connection
        quota = await client.uploads.check_quota(file_count=1)
        print(f"Connection successful!")
        print(f"Monthly limit: {quota.monthly_limit}")
        print(f"Current usage: {quota.current_usage}")
        print(f"Available: {quota.available}")

asyncio.run(test_connection())

Security Note

Never commit your API key to version control. Always use environment variables or a secure secrets manager. The SDK will validate your API key format on initialization.

Optional: Install with Extras

Install with optional dependencies for additional features

# Install with .env file support
pip install "aion[dotenv]" --extra-index-url https://aion:YOUR_API_KEY@api.aionvision.tech/api/v2/sdk/simple/

# Install with OpenTelemetry tracing
pip install "aion[tracing]" --extra-index-url https://aion:YOUR_API_KEY@api.aionvision.tech/api/v2/sdk/simple/

# Install all optional dependencies
pip install "aion[all]" --extra-index-url https://aion:YOUR_API_KEY@api.aionvision.tech/api/v2/sdk/simple/