# Search memories

POST https://api.xtrace.ai/v1/memories/search
Content-Type: application/json

Semantic search across a user's memory store using XTrace vector retrieval.

Reference: https://docs.x-mem.xtrace.ai/api-reference/memory/memories/search-memories

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: XTrace Memory API
  version: 1.0.0
paths:
  /memories/search:
    post:
      operationId: search-memories
      summary: Search memories
      description: >-
        Semantic search across a user's memory store using XTrace vector
        retrieval.
      tags:
        - subpackage_memories
      parameters:
        - name: Authorization
          in: header
          description: XTrace API key as Bearer token.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ranked results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchMemoriesResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchMemoriesRequest'
servers:
  - url: https://api.xtrace.ai/v1
components:
  schemas:
    SearchMemoriesRequest:
      type: object
      properties:
        query:
          type: string
        user_id:
          type: string
        agent_id:
          type: string
        limit:
          type: integer
          default: 10
        filters:
          type: object
          additionalProperties:
            description: Any type
          description: Metadata key/value filters applied post-retrieval.
      required:
        - query
        - user_id
      title: SearchMemoriesRequest
    SearchMemoriesResponseResultsItems:
      type: object
      properties:
        id:
          type: string
        memory:
          type: string
        user_id:
          type: string
        agent_id:
          type: string
        metadata:
          type: object
          additionalProperties:
            description: Any type
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        score:
          type: number
          format: double
      required:
        - id
        - memory
      title: SearchMemoriesResponseResultsItems
    SearchMemoriesResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/SearchMemoriesResponseResultsItems'
      title: SearchMemoriesResponse
    Error:
      type: object
      properties:
        error:
          type: string
        details:
          type: object
          additionalProperties:
            description: Any type
      required:
        - error
      title: Error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: XTrace API key as Bearer token.

```

## SDK Code Examples

```python Top match
import requests

url = "https://api.xtrace.ai/v1/memories/search"

headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Top match
const url = 'https://api.xtrace.ai/v1/memories/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: undefined
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Top match
package main

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

func main() {

	url := "https://api.xtrace.ai/v1/memories/search"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Top match
require 'uri'
require 'net/http'

url = URI("https://api.xtrace.ai/v1/memories/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'

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

```java Top match
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.xtrace.ai/v1/memories/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .asString();
```

```php Top match
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.xtrace.ai/v1/memories/search', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Top match
using RestSharp;

var client = new RestClient("https://api.xtrace.ai/v1/memories/search");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);
```

```swift Top match
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.xtrace.ai/v1/memories/search")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

```python Simple query
import requests

url = "https://api.xtrace.ai/v1/memories/search"

payload = {
    "query": "Where does the user live?",
    "user_id": "user_alice",
    "limit": 5
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Simple query
const url = 'https://api.xtrace.ai/v1/memories/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"query":"Where does the user live?","user_id":"user_alice","limit":5}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Simple query
package main

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

func main() {

	url := "https://api.xtrace.ai/v1/memories/search"

	payload := strings.NewReader("{\n  \"query\": \"Where does the user live?\",\n  \"user_id\": \"user_alice\",\n  \"limit\": 5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Simple query
require 'uri'
require 'net/http'

url = URI("https://api.xtrace.ai/v1/memories/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"Where does the user live?\",\n  \"user_id\": \"user_alice\",\n  \"limit\": 5\n}"

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

```java Simple query
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.xtrace.ai/v1/memories/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"Where does the user live?\",\n  \"user_id\": \"user_alice\",\n  \"limit\": 5\n}")
  .asString();
```

```php Simple query
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.xtrace.ai/v1/memories/search', [
  'body' => '{
  "query": "Where does the user live?",
  "user_id": "user_alice",
  "limit": 5
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Simple query
using RestSharp;

var client = new RestClient("https://api.xtrace.ai/v1/memories/search");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"query\": \"Where does the user live?\",\n  \"user_id\": \"user_alice\",\n  \"limit\": 5\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Simple query
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "query": "Where does the user live?",
  "user_id": "user_alice",
  "limit": 5
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.xtrace.ai/v1/memories/search")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```