Skip to main content
POST
/
v4
/
profile
Get user profile
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({containerTag: '<string>'})
};

fetch('https://api.supermemory.ai/v4/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "profile": {
    "static": [
      "<string>"
    ],
    "dynamic": [
      "<string>"
    ],
    "buckets": {}
  },
  "searchResults": {
    "results": [
      "<unknown>"
    ],
    "total": 123,
    "timing": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
containerTag
string
required

Tag to filter the profile by. This can be an ID for your user, a project ID, or any other identifier you wish to use to filter memories.

​
q
string

Optional search query to include search results in the response

​
threshold
number

Threshold for search results. Only results with a score above this threshold will be included.

Required range: 0 <= x <= 1
​
filters
object

Optional metadata filters to apply to profile results and search results. Supports complex AND/OR queries with multiple conditions.

​
include
enum<string>[]

Profile sections to return. Omit to return all sections. Pass a subset to reduce payload — e.g. ["buckets"] skips static and dynamic entirely.

Available options:
static,
dynamic,
buckets
​
buckets
string[]

Specific bucket keys to return. Omit to return all configured buckets. Only relevant when "buckets" is included.

Response

User profile with optional search results

​
profile
object
required
​
searchResults
object

Search results if a search query was provided