# Add memories

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

Send conversational turns or raw text. XTrace extracts facts, episodes,
and artifacts, then stores them in the user's encrypted KB.
When `async_mode` is true (default), returns queued event stubs.


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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: XTrace Memory API
  version: 1.0.0
paths:
  /memories:
    post:
      operationId: add-memories
      summary: Add memories
      description: |
        Send conversational turns or raw text. XTrace extracts facts, episodes,
        and artifacts, then stores them in the user's encrypted KB.
        When `async_mode` is true (default), returns queued event stubs.
      tags:
        - subpackage_memories
      parameters:
        - name: Authorization
          in: header
          description: XTrace API key as Bearer token.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Memories queued or persisted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddMemoriesResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddMemoriesRequest'
servers:
  - url: https://api.xtrace.ai/v1
components:
  schemas:
    ChatMessageRole:
      type: string
      enum:
        - user
        - assistant
        - system
      title: ChatMessageRole
    ChatMessage:
      type: object
      properties:
        role:
          $ref: '#/components/schemas/ChatMessageRole'
        content:
          type: string
      required:
        - role
        - content
      title: ChatMessage
    AddMemoriesRequestOutputFormat:
      type: string
      enum:
        - v1.0
        - v1.1
      default: v1.1
      title: AddMemoriesRequestOutputFormat
    AddMemoriesRequest:
      type: object
      properties:
        user_id:
          type: string
          description: Scope memories to this user.
        agent_id:
          type: string
        messages:
          type: array
          items:
            $ref: '#/components/schemas/ChatMessage'
          description: Conversation turns for inference-based extraction.
        memory:
          type: string
          description: Raw text when not using conversational inference.
        metadata:
          type: object
          additionalProperties:
            description: Any type
        infer:
          type: boolean
          default: true
          description: Run XTrace extraction pipeline before storing.
        async_mode:
          type: boolean
          default: true
          description: Return immediately with event stubs.
        output_format:
          $ref: '#/components/schemas/AddMemoriesRequestOutputFormat'
      title: AddMemoriesRequest
    AddMemoriesResponseResultsItemsEvent:
      type: string
      enum:
        - ADD
        - UPDATE
        - DELETE
        - NOOP
      title: AddMemoriesResponseResultsItemsEvent
    AddMemoriesResponseResultsItemsData:
      type: object
      properties:
        memory:
          type: string
      title: AddMemoriesResponseResultsItemsData
    AddMemoriesResponseResultsItems:
      type: object
      properties:
        id:
          type: string
        event:
          $ref: '#/components/schemas/AddMemoriesResponseResultsItemsEvent'
        data:
          $ref: '#/components/schemas/AddMemoriesResponseResultsItemsData'
      title: AddMemoriesResponseResultsItems
    AddMemoriesResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/AddMemoriesResponseResultsItems'
      title: AddMemoriesResponse
    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 Async events
import requests

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

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

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

print(response.json())
```

```javascript Async events
const url = 'https://api.xtrace.ai/v1/memories';
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 Async events
package main

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

func main() {

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

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

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

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 Async events
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

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

```php Async events
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Async events
using RestSharp;

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

```swift Async events
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.xtrace.ai/v1/memories")! 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 From chat messages
import requests

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

payload = {
    "user_id": "user_alice",
    "messages": [
        {
            "role": "user",
            "content": "I moved to Austin last month."
        },
        {
            "role": "assistant",
            "content": "Nice! Austin is a great city. I'll remember that."
        }
    ],
    "metadata": { "source": "onboarding" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript From chat messages
const url = 'https://api.xtrace.ai/v1/memories';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"user_id":"user_alice","messages":[{"role":"user","content":"I moved to Austin last month."},{"role":"assistant","content":"Nice! Austin is a great city. I\'ll remember that."}],"metadata":{"source":"onboarding"}}'
};

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

```go From chat messages
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"user_id\": \"user_alice\",\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"I moved to Austin last month.\"\n    },\n    {\n      \"role\": \"assistant\",\n      \"content\": \"Nice! Austin is a great city. I'll remember that.\"\n    }\n  ],\n  \"metadata\": {\n    \"source\": \"onboarding\"\n  }\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 From chat messages
require 'uri'
require 'net/http'

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

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  \"user_id\": \"user_alice\",\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"I moved to Austin last month.\"\n    },\n    {\n      \"role\": \"assistant\",\n      \"content\": \"Nice! Austin is a great city. I'll remember that.\"\n    }\n  ],\n  \"metadata\": {\n    \"source\": \"onboarding\"\n  }\n}"

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

```java From chat messages
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.xtrace.ai/v1/memories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"user_alice\",\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"I moved to Austin last month.\"\n    },\n    {\n      \"role\": \"assistant\",\n      \"content\": \"Nice! Austin is a great city. I'll remember that.\"\n    }\n  ],\n  \"metadata\": {\n    \"source\": \"onboarding\"\n  }\n}")
  .asString();
```

```php From chat messages
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.xtrace.ai/v1/memories', [
  'body' => '{
  "user_id": "user_alice",
  "messages": [
    {
      "role": "user",
      "content": "I moved to Austin last month."
    },
    {
      "role": "assistant",
      "content": "Nice! Austin is a great city. I\'ll remember that."
    }
  ],
  "metadata": {
    "source": "onboarding"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp From chat messages
using RestSharp;

var client = new RestClient("https://api.xtrace.ai/v1/memories");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"user_id\": \"user_alice\",\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"I moved to Austin last month.\"\n    },\n    {\n      \"role\": \"assistant\",\n      \"content\": \"Nice! Austin is a great city. I'll remember that.\"\n    }\n  ],\n  \"metadata\": {\n    \"source\": \"onboarding\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift From chat messages
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "user_id": "user_alice",
  "messages": [
    [
      "role": "user",
      "content": "I moved to Austin last month."
    ],
    [
      "role": "assistant",
      "content": "Nice! Austin is a great city. I'll remember that."
    ]
  ],
  "metadata": ["source": "onboarding"]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.xtrace.ai/v1/memories")! 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()
```

```python Direct text
import requests

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

payload = {
    "user_id": "user_alice",
    "memory": "Prefers dark mode in all editors",
    "infer": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Direct text
const url = 'https://api.xtrace.ai/v1/memories';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"user_id":"user_alice","memory":"Prefers dark mode in all editors","infer":false}'
};

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

```go Direct text
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"user_id\": \"user_alice\",\n  \"memory\": \"Prefers dark mode in all editors\",\n  \"infer\": false\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 Direct text
require 'uri'
require 'net/http'

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

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  \"user_id\": \"user_alice\",\n  \"memory\": \"Prefers dark mode in all editors\",\n  \"infer\": false\n}"

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

```java Direct text
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.xtrace.ai/v1/memories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"user_alice\",\n  \"memory\": \"Prefers dark mode in all editors\",\n  \"infer\": false\n}")
  .asString();
```

```php Direct text
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.xtrace.ai/v1/memories', [
  'body' => '{
  "user_id": "user_alice",
  "memory": "Prefers dark mode in all editors",
  "infer": false
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Direct text
using RestSharp;

var client = new RestClient("https://api.xtrace.ai/v1/memories");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"user_id\": \"user_alice\",\n  \"memory\": \"Prefers dark mode in all editors\",\n  \"infer\": false\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Direct text
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "user_id": "user_alice",
  "memory": "Prefers dark mode in all editors",
  "infer": false
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.xtrace.ai/v1/memories")! 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()
```