Welcome to Aspect API
The Aspect API provides powerful AI-driven indexing, analysis, and search capabilities for video and image assets. Our API enables you to upload media files, automatically extract metadata, generate transcriptions, create embeddings, analyze content with natural language queries, and perform intelligent search across your media library.Key Concepts
Before getting started, understand these core concepts:- Assets - Videos or images that are AI-indexed by our system
- Indexes - Organizational containers that group related assets together (all searches will be per-index)
- Tasks - Individual processing operations that can include any combination of features
- Features - A unit of processing that we can run on your asset (proxy, preview, embedding, transcription, metadata)
Typical Workflow
- Create an Index - Set up a container for your assets with default features
- Upload Assets - Add video or image files to your index with specified processing tasks
- Monitor Progress - Receive real-time notifications about indexing status via webhooks or SSE
- Analyze Content - Ask natural language questions about your assets or locate objects within images/videos
- Search & Retrieve - Query your indexed content using natural language or filters
Analysis Capabilities
Beyond indexing, our API offers powerful analysis features:- Natural Language Q&A - Ask questions about image/video content and get detailed answers
- Object Detection - Find and locate specific objects within your visual content
- Coordinate Mapping - Get precise pixel coordinates for objects in images/video frames
- Content Understanding - Extract insights about scenes, actions, text, and visual elements
Authentication
The Aspect API supports two authentication methods:API Keys
Each API key provides full access to your Aspect account. All API requests must include your API key in the Authorization header:Getting Your API Key
- Log into the Aspect Dashboard
- Navigate to API Keys in the left sidebar
- Click Create New API Key
- Give your key a descriptive name
- Copy the key (it will only be shown once!)
Keep your API keys secure and never expose them in client-side code. API keys provide full access to your account.
SDK Documentation
We provide official SDKs for popular programming languages to make integration easier:Node.js SDK
Our Node.js SDK provides full type safety and comprehensive API coverage.aspect-hq on NPM
View complete documentation and installation guide
Python SDK
Our Python SDK offers a Pythonic interface with full async support.aspect-media-engine-sdk on PyPI
View complete documentation and installation guide
Need Help?
- Documentation: Comprehensive guides and examples
- Support: Contact our team at support@aspect.ai
- Status Page: Check service status at status.aspect.ai