# Recall memories

POST https://api.forbocai.com/v1/agents/{agentId}/memory/recall
Content-Type: application/json

Semantic search over agent memories.

Reference: https://docs.forboc.ai/api-reference/endpoints/forboc-ai-sdk-api/memory/recall-memories

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Recall memories
  version: endpoint_memory.recallMemories
paths:
  /agents/{agentId}/memory/recall:
    post:
      operationId: recall-memories
      summary: Recall memories
      description: Semantic search over agent memories.
      tags:
        - - subpackage_memory
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Recalled memories
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MemoryWithScore'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemoryRecallRequest'
components:
  schemas:
    MemoryRecallRequest:
      type: object
      properties:
        query:
          type: string
        limit:
          type: integer
          default: 5
        minScore:
          type: number
          format: double
          default: 0.5
      required:
        - query
    MemoryMetadata:
      type: object
      properties: {}
    MemoryWithScore:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        type:
          type: string
        timestamp:
          type: string
          format: date-time
        metadata:
          $ref: '#/components/schemas/MemoryMetadata'
        score:
          type: number
          format: double

```

## SDK Code Examples

```python
import requests

url = "https://api.forbocai.com/v1/agents/agentId/memory/recall"

payload = {
    "query": "Why should I trust the player?",
    "limit": 5
}
headers = {"Content-Type": "application/json"}

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

print(response.json())
```

```javascript
const url = 'https://api.forbocai.com/v1/agents/agentId/memory/recall';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"query":"Why should I trust the player?","limit":5}'
};

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

```go
package main

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

func main() {

	url := "https://api.forbocai.com/v1/agents/agentId/memory/recall"

	payload := strings.NewReader("{\n  \"query\": \"Why should I trust the player?\",\n  \"limit\": 5\n}")

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

	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
require 'uri'
require 'net/http'

url = URI("https://api.forbocai.com/v1/agents/agentId/memory/recall")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"Why should I trust the player?\",\n  \"limit\": 5\n}"

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

```java
HttpResponse<String> response = Unirest.post("https://api.forbocai.com/v1/agents/agentId/memory/recall")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"Why should I trust the player?\",\n  \"limit\": 5\n}")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.forbocai.com/v1/agents/agentId/memory/recall', [
  'body' => '{
  "query": "Why should I trust the player?",
  "limit": 5
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
var client = new RestClient("https://api.forbocai.com/v1/agents/agentId/memory/recall");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"query\": \"Why should I trust the player?\",\n  \"limit\": 5\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "query": "Why should I trust the player?",
  "limit": 5
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.forbocai.com/v1/agents/agentId/memory/recall")! 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()
```