Documentation

Scopix Documentation

What is Scopix?

Scopix automatically annotates your images and documents — then makes them searchable. Every file you upload is annotated with AI descriptions, keyword tags, OCR text, color analysis, neural embeddings, and structured metadata. Search across your entire library by meaning, not just filenames. Structured, typed outputs plug directly into your agents, pipelines, or internal tools.

Upload→Annotate→Search & Query

Supported media: Images (JPEG, PNG, WebP, GIF), Documents (PDF, DOCX, TXT, MD)

Core Capabilities

Upload & Annotate

Upload files and get structured annotations — descriptions, tags, OCR text, and metadata — automatically.

Semantic Search

Find images and documents by meaning, not just keywords.

Agentic Chat

Multi-turn AI conversations about your content library with streaming support.

Organize & Export

Folders, datasets, cloud storage, and data export for your files.

🚀 New to Scopix API/SDK?

Get your first API call working in just 5 minutes with our complete setup guide.

Start Here: 5-Minute Quick Start API Reference SDK Reference GitHub

Choose Your Interface

Python SDK

Recommended for Python apps. One-line operations, built-in retries, typed responses.

REST API

For any language. Direct HTTP access to all endpoints.

Quick Install

bash

pip install scopix --extra-index-url https://scopix:YOUR_API_KEY@api.scopix.ai/api/v2/sdk/simple/

Replace YOUR_API_KEY with your API key.

Quick Example

Upload an image and get structured annotations

python

import asyncio
from scopix import Scopix

async def main():
    async with Scopix(api_key="scopix_...") as client:
        # Upload and automatically get AI description
        result = await client.files.upload("photo.jpg")
        print(f"Description: {result.description}")
        print(f"Tags: {result.tags}")

asyncio.run(main())

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.