API Reference
Remind

Remind

POST

/v1/remind

Get contextual reminders based on current context. Useful for surfacing relevant past memories when you provide current context.

Request Body

ParameterTypeRequiredDescription
contextstringYesCurrent context to find related memories
limitnumberNoMax reminders to return (default: 5)
thresholdnumberNoMinimum relevance score (default: 0.6)
timeframestringNoTime filter: today, week, month, all

Use Cases

  • Meeting preparation: Get relevant context before a meeting
  • Writing assistance: Surface related notes while writing
  • Context switching: Remember important details when starting a task
  • Follow-up reminders: Find action items related to current work

Examples

Basic Reminder

curl -X POST https://api.hypersave.io/v1/remind \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "context": "Meeting with the product team about the new dashboard feature",
    "limit": 5
  }'

Time-Scoped Reminders

Get reminders from a specific timeframe:

curl -X POST https://api.hypersave.io/v1/remind \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "context": "Customer onboarding process",
    "timeframe": "week",
    "limit": 3
  }'

Response

{
  "success": true,
  "reminders": [
    {
      "id": "doc_abc123",
      "title": "Dashboard Feature Discussion",
      "content": "Previous meeting notes: Team agreed on chart library selection...",
      "relevance": 0.92,
      "createdAt": "2024-01-10T14:00:00Z",
      "reason": "Directly related to dashboard feature planning"
    },
    {
      "id": "doc_xyz789",
      "title": "Product Roadmap Q1",
      "content": "Dashboard improvements listed as priority 2...",
      "relevance": 0.85,
      "createdAt": "2024-01-05T09:30:00Z",
      "reason": "Contains product team priorities"
    },
    {
      "id": "doc_def456",
      "title": "User Feedback Summary",
      "content": "Users requested better data visualization...",
      "relevance": 0.78,
      "createdAt": "2023-12-20T11:15:00Z",
      "reason": "User feedback related to dashboard"
    }
  ],
  "totalFound": 12
}

Response Fields

FieldTypeDescription
remindersarrayArray of relevant memories
reminders[].idstringMemory ID
reminders[].titlestringMemory title
reminders[].contentstringContent preview
reminders[].relevancenumberRelevance score (0-1)
reminders[].reasonstringWhy this memory is relevant
totalFoundnumberTotal matching memories found

The reason field explains why each reminder was surfaced, helping you quickly assess relevance.

Error Responses

Missing Context

{
  "success": false,
  "error": "VALIDATION_ERROR",
  "message": "Context is required"
}

Context Too Short

{
  "success": false,
  "error": "VALIDATION_ERROR",
  "message": "Context must be at least 10 characters"
}