Sign in
Profiles

Get user profile

Get user profile with optional search results

post/v4/profile

Request body

qstring

Optional search query to include search results in the response

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

thresholdnumber

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

includestring[]

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

bucketsstring[]

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

Response

User profile with optional search results

Example response

{
  "searchResults": {
    "results": [
      {
        "id": "mem_abc123",
        "memory": "The user prefers detailed API responses over minimal ones.",
        "chunk": "This is a chunk of content from a document...",
        "metadata": {
          "source": "conversation",
          "confidence": 0.9
        },
        "similarity": 0.89,
        "version": 3,
        "rootMemoryId": "mem_abc123",
        "context": {
          "parents": [
            {
              "relation": "updates",
              "version": -1,
              "memory": "Earlier version: API rate limit is 50 req/min on the free tier."
            }
          ],
          "children": [
            {
              "relation": "extends",
              "version": 1,
              "memory": "Later version: API rate limit increased to 100 req/min on the free tier."
            }
          ]
        },
        "documents": [
          {
            "id": "doc_xyz789",
            "title": "API Rate Limiting Policy",
            "type": "web",
            "metadata": {
              "source": "upload",
              "language": "en"
            },
            "summary": "API rate limit policy: 100 req/min free, 1000 req/min pro."
          }
        ],
        "chunks": [
          {
            "content": "This is a chunk of content from the document...",
            "documentId": "doc_xyz789"
          }
        ]
      }
    ]
  }
}

Changes