Search your memories with a natural-language query.

Runs a relevance-ranked full-text search over the caller’s own memories. Returns an empty result set (not an error) when nothing matches.

GET /v1/memory/search

Search your memories with a natural-language query.

cURL

curl --request GET \
  --url https://api.example.com/v1/memory/search

import requests

url = "https://api.example.com/v1/memory/search"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v1/memory/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/memory/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/memory/search"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/memory/search")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/memory/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "results": [
    {
      "id": "<string>",
      "content": "<string>",
      "tags": [
        "<string>"
      ],
      "source": "<string>",
      "scope": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "score": 123
    }
  ]
}

{
  "error": "<string>",
  "details": [
    {
      "message": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}

{
  "error": "<string>"
}

Query Parameters

q · string · required

Required string length: 1 - 512

limit · integer · default: 20

Required range: 1 <= x <= 50

Response

200

application/json

Search results returned successfully.

results · object[] · required

Show child attributes