Profile
Generate a summary
Retrieve a deterministic, LLM-ready summary of a user’s memory and context. This endpoint compiles all available user data — including events, documents, and inferred traits — into a concise, text-based summary optimized for downstream reasoning and personalization.
GET /summary
Purpose
Use this endpoint when your agent or system needs a stable, up-to-date overview of a user.
Summaries are ideal for:
Initializing LLM prompts with consistent background context.
Providing user-aware grounding for reasoning and scheduling.
Generating cached, deterministic representations of the user profile.
Each summary is tuned to a purpose (e.g., work-style, persona, or preferences) and can be truncated to a specified length.
Endpoint
Headers
Query Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Unique identifier of the user. |
| string | Optional | Defines what kind of summary to generate ( |
| integer | Optional | Limit the character length of the returned summary. |
| integer | Optional | Restrict the summary to data ingested within a certain time window (e.g., |
Example Request
Example cURL
Example Response
Response Fields
Field | Type | Description |
|---|---|---|
| string | The user ID this summary was generated for. |
| string | ISO 8601 UTC timestamp when the summary was generated. |
| string | The purpose tag for this summary (e.g., |
| string | Deterministic text summary of the user’s preferences, habits, or behavior. |
Behavior
Summaries are deterministic — given the same input data, you’ll receive the same output.
If no
purposeis specified, the default general summary is returned.The response text can be safely embedded in model prompts or serialized into other systems.
Summaries refresh automatically as new ingested data becomes available.
Error Responses
HTTP Code | Error Code | Description |
|---|---|---|
|
| Missing or malformed query parameters. |
|
| Invalid or missing API key. |
|
| No profile data found for the given |
|
| Internal error — retry after short delay. |
Example:
Example Implementation (Python)
Best Practices
Use meaningful
purposevalues to tailor the summary for specific agent tasks (e.g.,persona,decision-style,schedule-context).Cache summaries locally when used frequently; they update only when new data is ingested.
Keep
max_charsunder 2000 for efficient model embedding and prompt usage.Use
freshness_daysfor time-sensitive applications to limit the data window.If building with multiple agents, standardize
purposetags for consistency.
Related Endpoints
Endpoint | Description |
|---|---|
POST | Ask a natural-language question about the user. |
POST | Retrieve top-k user snippets for grounding. |
POST | Feed new user data for learning and summary updates. |
Summary:
Use GET /summary to generate a structured, purpose-specific summary of any user.
These summaries are deterministic, composable, and ideal for grounding model behavior and agent reasoning.
Join our Discord Community