Documentation

Get Started with Scopix API in 5 Minutes

Complete guide from account creation to your first successful API call

Step 1: Create Your Account (1 minute)

1. Visit scopix.ai/auth/register

2. Sign up with Google (no email verification required) — or enter your email and create a password

3. If signing up with email, verify your email address

4. Complete your profile setup

Step 2: Upgrade Your Plan (1 minute)

⚠️ API Access Requirement

API access requires a paid plan. The Free tier does not include API access.

Paid plans include:

Full REST API access
Python SDK included
Higher upload limits
API rate limit allowance

View Pricing →

Step 3: Create Your API Key (1 minute)

1. Navigate to Dashboard → API Keys tab

2. Click "Create New API Key"

3. Give your key a descriptive name (e.g., "Production API")

4. Copy the API key - format: scopix_...

5. Store it securely (it's shown only once!)

Go to Dashboard →

Step 4: Make Your First API Call (2 minutes)

Choose your preferred method below. We recommend starting with the Python SDK for the best experience.

Option A: Python SDK (Recommended)

The official Python SDK provides the easiest and most robust way to integrate with Scopix.

bash

# Install the SDK (use the API key you just created)
pip install scopix --extra-index-url https://scopix:scopix_YOUR_KEY_HERE@api.scopix.ai/api/v2/sdk/simple/

python

import asyncio
from scopix import Scopix

async def main():
    # Initialize client with your API key
    async with Scopix(api_key="scopix_YOUR_KEY_HERE") as client:
        # Upload and describe an image in one call
        result = await client.files.upload("path/to/photo.jpg")

        # Print the AI-generated description
        print(f"Description: {result.description}")
        print(f"Image ID: {result.image_id}")

# Run the async function
asyncio.run(main())

View full SDK documentation →

Option B: REST API (Simplest)

One HTTP call uploads your image and returns its AI description, tags, and extracted text.

bash

curl -X POST https://api.scopix.ai/api/v2/images/analyze \
  -H "Authorization: Bearer scopix_YOUR_KEY_HERE" \
  -F "file=@photo.jpg"

# Response includes:
# - image_id: Unique identifier for your uploaded image
# - status: "completed" when description is ready
# - description: AI-generated description
# - tags: Extracted keyword tags
# - visible_text: Any text detected in the image

📦 For Large Files

The streaming upload supports files up to 100MB. For images larger than 100MB, resize or compress before uploading.

View Image Analysis API reference →

Coding with AI? Index this repo

If you're using an AI coding assistant (Cursor, Copilot, Claude Code, etc.), point it at our GitHub repository so it can reference the SDK source, types, and examples directly.

What's Next?

📚 API Reference

Explore all 15 endpoint categories

💡 Code Examples

Advanced use cases and patterns

📖 Guides

Uploads, search, chat, and more

Troubleshooting

❌ "Invalid API key"

→ Double-check you copied the full key including the scopix_ prefix

❌ "Insufficient subscription tier"

→ Your account is on the Free tier. Upgrade to STARTER or higher at /pricing

❌ "Rate limit exceeded"

→ Rate limits: STARTER (30/min), PROFESSIONAL (100/min), ENTERPRISE (500/min). Wait a minute or upgrade your plan.

⚠️ Still having issues?

Contact support at support@scopix.ai or check our authentication guide