Backboard API home pagelight logo
  1. Memories
  2. Search Memories
POST
/assistants/{assistant_id}/memories/search
curl --request POST \
     --url https://app.backboard.io/api/assistants/{assistant_id}/memories/search \
     --header 'X-API-Key: <api-key>' \
     --header 'Content-Type: application/json' \
     --data '{
  "query": "string",
  "limit": 5
}'

​
Path Parameters

assistant_id
required
uuid

The unique identifier of the assistant

​
Request Body

query
required
string

Search query text to find relevant memories

limit
default:5
integer

Maximum number of memories to return (min: 1, max: 50)

​
Response

Returns a list of memories that match the search query, ranked by relevance.

memories
required
array

List of relevant memories without metadata

total_count
required
integer

Total number of memories found matching the query

​
Example Request

curl -X POST https://app.backboard.io/api/assistants/123e4567-e89b-12d3-a456-426655440000/memories/search \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "user preferences for notifications",
    "limit": 10
  }'

​
Example Response

{
  "memories": [
    {
      "id": "mem_abc123",
      "content": "User prefers email notifications over SMS",
      "score": 0.95,
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "mem_def456",
      "content": "User wants daily summary notifications at 9 AM",
      "score": 0.87,
      "created_at": "2024-01-20T14:45:00Z"
    }
  ],
  "total_count": 2
}