​
Basic Usage

To add a memory, send a POST request to /add with your content: 
curl https://api.supermemory.ai/v3/memories \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "customId": "xyz-my-db-id",
  "content": "This is the content of my memory",
  "metadata": {
    "category": "technology",
    "tag_1": "ai",
    "tag_2": "machine-learning",
  },
  "containerTags": ["user_123", "project_xyz"]
}'
The API will return a response with an ID and initial status: 
{
  "id": "mem_abc123",
  "status": "queued"
}

curl https://api.supermemory.ai/v3/memories \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  -d '{
    "content": "https://example.com/article",
    "metadata": {
      "source": "web",			# Just example metadata
      "category": "technology"	# NOT required
    },
    "containerTags": ["user_456", "research_papers"]
  }'

​
Metadata and Organization

You can add rich metadata to organize your content: 
{
  "metadata": {
    "source": "string",      // String 
    "priority": 1234,   // Custom numeric field
    "custom_field": "any"   // Any custom field
  }
}

​
Partitioning by user

You can attribute and partition your data by providing a userId: 
curl https://api.supermemory.ai/v3/memories \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  -d '{
    "content": "This is space-specific content",
    "userId": "space_123",
    "metadata": {
      "category": "space-content"
    }
  }'
When searching, if you provide a userId, only memories from that space will be returned.

​
Grouping

You can group memories by providing an array of containerTags: 
curl https://api.supermemory.ai/v3/memories \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  -d '{
    "content": "This is space-specific content",
    "containerTags": ["user_123", "project_xyz"]
  }'

​
Checking Status

Check status using the memory ID: 
curl https://api.supermemory.ai/v3/memories/mem_abc123 \
  --request GET \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
Memories are deleted after 2 minutes if an irrecoverable error occurs.

​
Next Steps

Explore more advanced features in our API Reference