Documentation

REST API Quick Start

Get up and running with the Aionvision REST API in 5 minutes

🚀 Complete Getting Started Guide

For the complete journey including account creation and subscription setup, see our 5-Minute Quick Start Guide

1. Get Your API Key

1. Register at aionvision.tech

2. Upgrade to STARTER plan or higher (API access requires paid plan)

3. Navigate to Dashboard → API Keys tab

4. Create a new API key with appropriate permissions

5. Copy your API key (format: aion_...)

2. Upload Your First Image (Streaming)

Upload a file and queue AI description generation in a single request

curl -X POST https://api.aionvision.tech/api/v2/user-files/upload/stream \
  -H "Authorization: Bearer aion_your_api_key_here" \
  -F "file=@photo.jpg"

# Response includes:
# - image_id: Unique identifier for your uploaded image
# - status: "completed" or "processing"
# - description_queued: true if AI description is being generated

📦 For Large Files or Production

The streaming upload works great for files up to 100MB. For larger files or production applications, use the presigned URL flow which handles uploads in chunks with better reliability.

3. Python Example (REST API)

Upload using the streaming endpoint with Python requests

import requests

API_KEY = "aion_your_api_key_here"
BASE_URL = "https://api.aionvision.tech/api/v2"

# Upload and describe in one request
with open("photo.jpg", "rb") as f:
    response = requests.post(
        f"{BASE_URL}/user-files/upload/stream",
        headers={"Authorization": f"Bearer {API_KEY}"},
        files={"file": f}
    )

result = response.json()
print(f"Image ID: {result['image_id']}")
print(f"Status: {result['status']}")
print(f"Description queued: {result['description_queued']}")

💡 Prefer Python SDK?

For Python applications, we recommend using our official SDK which provides a simpler interface with built-in retry logic and type safety. View SDK documentation →