Skip to main content

​
Prerequisites

Before you begin, you’ll need:
An API key from Memory Machines
A text file to upload (email, notes, etc.)
curl or any HTTP client
Don’t have an API key yet? Contact support@memorymachines.ai to get started.

​
Step 1: Test Your API Key

First, verify your API key works by checking the health endpoint: 
curl https://memorymachines-core-api-mvp-gateway-6v1lw71z.uc.gateway.dev/v1/health
You should see: 
{
  "status": "healthy",
  "message": "Memory Machines Platform API is running."
}

​
Step 2: Upload Your First Document

Create a sample text file or use an existing one: 
echo "Meeting Notes - January 15, 2025

Attendees: Sarah, Mike, Jennifer

We discussed the Q1 roadmap today. Sarah presented the new authentication
feature timeline - targeting end of February for beta. Mike raised concerns
about the current API response times, suggesting we prioritize performance
optimization before the launch.

Action items:
- Sarah: Finalize auth feature specs by Friday
- Mike: Run performance benchmarks this week
- Jennifer: Schedule follow-up for next Tuesday" > meeting-notes.txt
Now upload it: 
curl -X POST https://memorymachines-core-api-mvp-gateway-6v1lw71z.uc.gateway.dev/v1/memorize \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@meeting-notes.txt" \
  -F "user_name=Your Name" \
  -F "source_type=text"
You’ll receive a response like: 
{
  "status": "success",
  "user_id": "your_user_id",
  "item_id": "abc123",
  "workflow_execution": "projects/.../executions/exec-xyz"
}
Processing Time: Your document is now being processed by our Large Memory Models. Memory extraction typically completes in 10-15 seconds.

​
Step 3: Query Your Memories

Wait ~15 seconds for processing, then ask a question: 
curl -X POST https://memorymachines-core-api-mvp-gateway-6v1lw71z.uc.gateway.dev/v1/memories/ask \
  -H "x-api-key: YOUR_API_KEY" \
  -F "text=What were the action items from the meeting?"
You’ll get an LMM-generated response: 
{
  "response": "Based on your meeting notes from January 15th, there were three action items: Sarah needs to finalize the auth feature specs by Friday, Mike will run performance benchmarks this week, and Jennifer will schedule a follow-up meeting for next Tuesday."
}

​
Step 4: Recall Raw Memories

To see the actual extracted memories without LMM synthesis: 
curl -X POST https://memorymachines-core-api-mvp-gateway-6v1lw71z.uc.gateway.dev/v1/memories/recall \
  -H "x-api-key: YOUR_API_KEY" \
  -F "text=meeting"
Response: 
{
  "memories": [
    {
      "custom_id": "abc123_memory_0",
      "item_id": "abc123",
      "score": 0.94,
      "content": {
        "narrative": "I attended a meeting with Sarah, Mike, and Jennifer to discuss the Q1 roadmap. Sarah presented the authentication feature timeline targeting end of February. Mike raised concerns about API response times.",
        "participants": ["Sarah", "Mike", "Jennifer"],
        "when": "January 15, 2025",
        "where": null,
        "tags": ["meeting", "Q1", "roadmap", "authentication"]
      }
    }
  ],
  "qa": [],
  "chunks": []
}

​
Next Steps

Authentication

Learn about API key management

API Reference

Complete API documentation

​
Common Issues

Your API key is invalid or missing. Make sure you’re including the x-api-key header with your request.
Processing takes 10-15 seconds. Wait a moment and try again. You can also check if the document was uploaded successfully by looking at the response from /v1/memorize.
Check that your file is UTF-8 encoded text and under 10MB. Binary files (PDF, images) are not yet supported.