> ## 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.

# Create Your API Key

> Get started with Memories.ai API by creating your first API key

## Welcome to Visual Intelligence API Platform 🚀

Memories.ai provides a comprehensive suite of tools for video processing, understanding, and AI-powered analysis. To get started, you'll need to create an API key.

<Info>
  **Quick Start**: Create your API key in under 2 minutes and start building with our powerful video AI APIs.
</Info>

## Platform Overview

Our API platform offers five core modules to power your video applications:

<CardGroup cols={2}>
  <Card title="Video Processing" icon="film">
    Frame sampling, editing, and asset management
  </Card>

  <Card title="Video Understanding" icon="brain">
    Video-to-text, audio-to-text, multimodal speaker recognition
  </Card>

  <Card title="Video Data Retrieval" icon="download">
    Download from YouTube/TikTok/Instagram/X, plus transcription
  </Card>

  <Card title="VLM Router" icon="route">
    Unified gateway to multiple vision-language models
  </Card>

  <Card title="Embeddings" icon="vector-square">
    Multimodal video embeddings, image embeddings, text embeddings
  </Card>

  <Card title="Developer Platform" icon="code">
    Usage tracking, webhooks, payments, and task management
  </Card>
</CardGroup>

## Creating Your API Key

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

<Steps>
  <Step title="Access Console">
    Navigate to the [Visual Intelligence API Platform](https://api-platform.memories.ai/) to get started.

    <Note>
      The platform provides a unified interface for managing your API keys, monitoring usage, and configuring webhooks.
    </Note>
  </Step>

  <Step title="Sign In or Create an Account">
    Choose your preferred authentication method:

    <CardGroup cols={2}>
      <Card title="Memories.ai Account" icon="user">
        Sign in with your existing Memories.ai credentials
      </Card>

      <Card title="Google" icon="google">
        Sign in with your Google account
      </Card>

      <Card title="Apple" icon="apple">
        Sign in with your Apple ID
      </Card>

      <Card title="Microsoft" icon="microsoft">
        Sign in with your Microsoft account
      </Card>
    </CardGroup>
  </Step>

  <Step title="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

    <Tip>
      You can create multiple API keys for different projects or environments (development, staging, production).
    </Tip>
  </Step>

  <Step title="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

    <Warning>
      **Security Best Practice**: Treat your API key like a password. Store it in environment variables or a secure key management system.
    </Warning>
  </Step>
</Steps>

## Using Your API Key

Once you have your API key, include it in the `Authorization` header of all API requests:

<CodeGroup>
  ```python Python theme={null}
  import requests

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

  headers = {
      "Authorization": API_KEY
  }

  response = requests.post(
      f"{BASE_URL}/upload",
      headers=headers,
      files={"file": open("video.mp4", "rb")}
  )

  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const API_KEY = 'sk-mavi-your-actual-key-here';
  const BASE_URL = 'https://mavi-backend.memories.ai/serve/api/v2';

  const formData = new FormData();
  formData.append('file', fileInput.files[0]);

  fetch(`${BASE_URL}/upload`, {
    method: 'POST',
    headers: {
      'Authorization': API_KEY
    },
    body: formData
  })
  .then(response => response.json())
  .then(data => console.log(data));
  ```

  ```curl cURL theme={null}
  curl -X POST "https://mavi-backend.memories.ai/serve/api/v2/upload" \
    -H "Authorization: sk-mavi-your-actual-key-here" \
    -F "file=@video.mp4"
  ```
</CodeGroup>

## Developer Platform Features

With your API key, you'll have access to our comprehensive developer platform:

<AccordionGroup>
  <Accordion title="Usage Tracking" icon="chart-line">
    Monitor your API usage in real-time:

    * Track API calls by endpoint
    * View token usage for AI models
    * Monitor storage consumption
    * Analyze usage patterns
  </Accordion>

  <Accordion title="Webhook Management" icon="webhook">
    Set up webhooks for async workflows:

    * Configure webhook endpoints for long-running tasks
    * Receive notifications when processing completes
    * Monitor callback records and success rates
    * Retry failed webhook deliveries
  </Accordion>

  <Accordion title="Payment & Billing" icon="credit-card">
    Manage your account billing:

    * Recharge your account using Stripe
    * View transaction history
    * Track monthly spending
    * Set up budget alerts
  </Accordion>

  <Accordion title="Task Management" icon="list-check">
    Track long-running tasks end-to-end:

    * Monitor video processing jobs
    * Check transcription status
    * View embedding generation progress
    * Access completed task results
  </Accordion>

  <Accordion title="Asset Management" icon="folder">
    Manage your uploaded media assets:

    * Browse uploaded videos, images, and audio
    * View asset metadata and processing status
    * Download or delete assets
    * Track storage usage
  </Accordion>
</AccordionGroup>

## What's Next?

Now that you have your API key, start exploring our capabilities:

<CardGroup cols={2}>
  <Card title="Upload Your First File" icon="upload" href="/visual-intelligence/base/upload">
    Learn how to upload video, audio, or image files
  </Card>

  <Card title="Video Understanding Models" icon="brain" href="/visual-intelligence/gemini/gemini-vlm">
    Analyze videos with AI-powered vision-language models
  </Card>

  <Card title="Audio to Text" icon="file-text" href="/visual-intelligence/transcript/whisper-audio-transcription">
    Convert audio and video to text with speaker identification
  </Card>

  <Card title="Create Embeddings" icon="vector-square" href="/visual-intelligence/embeddings/video-embedding">
    Generate vector embeddings for semantic search
  </Card>
</CardGroup>

## Need Help?

<CardGroup cols={2}>
  <Card title="API Documentation" icon="book" href="https://api-tools.memories.ai/">
    Explore our complete API reference
  </Card>

  <Card title="Contact Support" icon="headset" href="mailto:contact@memories.ai">
    Get help from our support team
  </Card>

  <Card title="Developer Platform" icon="laptop-code" href="https://api-platform.memories.ai/">
    Access your dashboard and manage API keys
  </Card>

  <Card title="Share Feedback" icon="comments">
    We'd love to hear your thoughts and suggestions!
  </Card>
</CardGroup>

<Note>
  **Coming Soon**: Agent marketplace and curated open-source integrations—all in one place.
</Note>
