Authorizations
Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.
Headers
REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
"Bearer sk_live_abc123def456"
"Bearer sk_test_xyz789"
Query Parameters
Supported external storage providers for ingestion and sync.
Mixpeek can connect to external storage providers to automatically ingest objects and keep them synchronized with your namespaces.
Providers: GOOGLE_DRIVE: Google Drive and Google Workspace shared drives. - Authentication: Service account or OAuth2 - Features: Shared drive support, real-time sync, metadata preservation - Use cases: Marketing assets, team documents, knowledge bases - Limitations: Rate limits apply (10,000 requests/100 seconds per user)
S3: Amazon S3 and S3-compatible storage (MinIO, DigitalOcean Spaces, etc).
- Authentication: Access keys or IAM role assumption
- Features: Bucket notifications, prefix filtering, versioning support
- Use cases: Data lakes, video archives, ML datasets, backups
- Limitations: IAM role assumption preferred over access keysConnection Requirements: - Valid credentials with read access to target files/buckets - Network connectivity from Mixpeek infrastructure - Appropriate IAM policies or share permissions configured
Examples: - Use GOOGLE_DRIVE for syncing team marketing materials - Use S3 for ingesting video archives from data lakes - Use S3 with IAM role for secure production deployments
google_drive, s3 Enumeration of task statuses for tracking asynchronous operations.
Task statuses indicate the current state of asynchronous operations like batch processing, object ingestion, clustering, and taxonomy execution.
Status Categories: Operation Statuses: Track progress of async operations Lifecycle Statuses: Track entity state (buckets, collections, namespaces)
Values: PENDING: Task is queued but has not started processing yet IN_PROGRESS: Task is currently being executed PROCESSING: Task is actively processing data (similar to IN_PROGRESS) COMPLETED: Task finished successfully with no errors FAILED: Task encountered an error and could not complete CANCELED: Task was manually canceled by a user or system UNKNOWN: Task status could not be determined SKIPPED: Task was intentionally skipped DRAFT: Task is in draft state and not yet submitted
ACTIVE: Entity is active and operational (for buckets, collections, etc.)
ARCHIVED: Entity has been archived
SUSPENDED: Entity has been temporarily suspendedTerminal Statuses: COMPLETED, FAILED, CANCELED are terminal statuses. Once a task reaches these states, it will not transition to another state.
Polling Guidance: - Poll tasks in PENDING, IN_PROGRESS, or PROCESSING states - Stop polling when task reaches COMPLETED, FAILED, or CANCELED - Use exponential backoff (1s → 30s) when polling
PENDING, IN_PROGRESS, PROCESSING, COMPLETED, FAILED, CANCELED, UNKNOWN, SKIPPED, DRAFT, ACTIVE, ARCHIVED, SUSPENDED 
