Skip to main content

​
Endpoint

POST /v4/profile Retrieves a user’s profile, optionally combined with search results.

​
Request

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer token with your API key
Content-TypeYesapplication/json

​
Body Parameters

ParameterTypeRequiredDescription
containerTagstringYesThe container tag (usually user ID) to get profiles for
qstringNoOptional search query to include search results with the profile

​
Response

{
  "profile": {
    "static": [
      "User is a software engineer",
      "User specializes in Python and React",
      "User prefers dark mode interfaces"
    ],
    "dynamic": [
      "User is working on Project Alpha",
      "User recently started learning Rust",
      "User is debugging authentication issues"
    ]
  },
  "searchResults": {
    "results": [...],  // Only if 'q' parameter was provided
    "total": 15,
    "timing": 45.2
  }
}

​
Response Fields

FieldTypeDescription
profile.staticstring[]Long-term, stable facts about the user
profile.dynamicstring[]Recent context and temporary information
searchResultsobjectOnly present if q parameter was provided
searchResults.resultsarrayMatching memory results
searchResults.totalnumberTotal number of matches
searchResults.timingnumberQuery execution time in milliseconds

​
Basic Request

const response = await fetch('https://api.supermemory.ai/v4/profile', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SUPERMEMORY_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    containerTag: 'user_123'
  })
});

const data = await response.json();

console.log("Static facts:", data.profile.static);
console.log("Dynamic context:", data.profile.dynamic);
Include a search query to get both profile data and relevant memories in one call: 
const response = await fetch('https://api.supermemory.ai/v4/profile', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SUPERMEMORY_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    containerTag: 'user_123',
    q: 'deployment errors yesterday'
  })
});

const data = await response.json();

// Profile data
const profile = data.profile;

// Search results (only present because we passed 'q')
const searchResults = data.searchResults?.results || [];

​
Error Responses

StatusDescription
400Missing or invalid containerTag
401Invalid or missing API key
404Container not found
500Internal server error

​
Rate Limits

Profile requests count toward your standard API rate limits. Since profiles are cached, repeated requests for the same user are efficient.

See Examples

View complete integration examples for chat apps, support systems, and more