Documentation
REST API Quick Start
Get up and running with the Scopix 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
Sign up and create an API key for authentication
1. Register at scopix.ai
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: scopix_...)
2. Analyze Your First Image
Upload and describe an image in a single request
curl -X POST https://api.scopix.ai/api/v2/images/analyze \ -H "Authorization: Bearer scopix_your_api_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 of the image# - tags: Extracted keyword tags# - visible_text: Any text detected in the imageFile Size Limit
Supports files up to 100MB. For larger files, consider compressing or resizing before uploading.
3. Python Example (REST API)
Analyze an image with Python requests
import requests
API_KEY = "scopix_your_api_key_here"BASE_URL = "https://api.scopix.ai/api/v2"
# Upload and describe in one requestwith open("photo.jpg", "rb") as f: response = requests.post( f"{BASE_URL}/images/analyze", headers={"Authorization": f"Bearer {API_KEY}"}, files={"file": f} )
result = response.json()print(f"Image ID: {result['image_id']}")print(f"Description: {result['description']}")print(f"Tags: {result['tags']}")Need More Control?
For advanced use cases like custom storage, multi-file uploads, or presigned URLs, see the Files reference. For Python apps, our SDK provides built-in retries and type safety.