Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api-tools.memories.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Welcome to Visual Search 🚀

Visual Search lets you upload videos and images, indexes them automatically, and search them by natural language, image, or transcript phrase. To get started, you’ll need to create an API key.
Quick Start: Create your API key in under 2 minutes and start indexing your video and image content.

​
Platform Overview

Visual Search organises your content into three libraries:

Private Video Library

Videos you upload. Searchable only by your account.

Private Image Library

Images you upload. Separate from the video library — different upload and search endpoints.

Public Video Library

Pre-indexed public TikTok / YouTube / Instagram videos. Shared across all API users.

​
Creating Your API Key

Follow these simple steps to create your API key and start indexing:
1

Access Console

Navigate to the Memories.ai Console to get started.
The console provides a unified interface for managing your API keys, monitoring usage, and configuring webhooks.
2

Sign In or Create an Account

Choose your preferred authentication method:

Memories.ai Account

Sign in with your existing Memories.ai credentials

Google

Sign in with your Google account

Apple

Sign in with your Apple ID

Microsoft

Sign in with your Microsoft account
3

Navigate to API Key Management

Once logged in:
  1. Go to the Payment section in the left sidebar
  2. Scroll down to API Key Management
  3. Click the Create Key button
You can create multiple API keys for different projects or environments (development, staging, production).
4

Copy and Secure Your API Key

After creating your key:
  • Copy your API key immediately (it looks like sk-mavi-xxxxx...)
  • Store it securely (you won’t be able to see it again)
  • Never commit it to version control or share it publicly
Security Best Practice: Treat your API key like a password. Store it in environment variables or a secure key management system.

​
Using Your API Key

Once you have your API key, include it in the Authorization header of every Visual Search request. Note: no Bearer prefix — pass the raw sk-mavi-... string. 
import requests

BASE_URL = "https://api.memories.ai/serve/api/v1"
API_KEY = "sk-mavi-your-actual-key-here"

headers = {"Authorization": API_KEY}

# Upload a video to your Private Video Library
with open("meeting.mp4", "rb") as f:
    response = requests.post(
        f"{BASE_URL}/upload",
        headers=headers,
        files={"file": ("meeting.mp4", f, "video/mp4")},
        data={"unique_id": "my-project"},
    )
print(response.json())

​
Developer Platform Features

With your API key, you also get access to the broader Memories.ai console:
Monitor your API usage in real-time:
  • Track API calls by endpoint
  • View token usage for AI models
  • Monitor storage consumption
  • Analyse usage patterns
Set up webhooks for async workflows:
  • Configure webhook endpoints for long-running scraper / parse tasks
  • Receive notifications when indexing completes
  • Monitor callback records and success rates
  • Retry failed webhook deliveries
Manage your account billing:
  • Recharge your account using Stripe
  • View transaction history
  • Track monthly spending
  • Set up budget alerts
Track long-running tasks end-to-end:
  • Monitor video parsing / indexing jobs
  • Check social-media scraper task status
  • View library growth over time
  • Access completed task results
Manage your indexed media:
  • Browse uploaded videos and images
  • View asset metadata and processing status
  • Download or delete assets
  • Track storage usage

​
What’s Next?

Now that you have your API key, start building:

Upload Your First Video

Send a video to your Private Video Library and wait for it to reach PARSE status.

Search by Text

Find moments across your indexed library using natural-language queries.

Import from Social Media

Import TikTok / YouTube / Instagram posts by URL, creator profile, or hashtag.

Library Management

List, get metadata for, download, or delete the videos in your indexed library.

​
Need Help?

API Documentation

Explore the complete API reference across all three products.

Contact Support

Get help from our support team.

Developer Console

Access your dashboard and manage API keys.

Share Feedback

We’d love to hear your thoughts and suggestions!