Skip to main content
POST
Add a memory

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Headers

X-As-User
string | null

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Body

application/json
text
string
required

Full text of the document.

Minimum string length: 1
resource_id
string

The resource ID to add the document to. If not provided, a new resource ID will be generated. If provided, the document will be updated if it already exists.

collection
string | null
deprecated

The collection to add the document to — deprecated, set the collection using metadata instead.

title
string | null

Title of the document.

date
string<date-time>

Date of the document. Depending on the document, this could be the creation date or date the document was last updated (eg. for a chat transcript, this would be the date of the last message). This helps the ranking algorithm and allows you to filter by date range.

metadata
Metadata · object | null

Custom metadata for filtering. Keys must be alphanumeric with underscores, max 64 chars. Values must be string, number, boolean, or null.

share
enum<string> | null

Who should see this memory, for a memory written on behalf of a user. personal (the default) keeps it visible to that user only. suggest keeps it personal and asks the user, in their Inbox, whether to share it with everyone in the app. shared shares it with everyone in the app once it is processed, and is only accepted when the app allows direct sharing. A memory written without a user is always visible to everyone in the app, so it accepts suggest and shared and refuses personal.

Available options:
personal,
suggest,
shared

Response

Successful Response

source
enum<string>
required
Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
imap,
google_meet,
box,
dropbox,
github,
gitlab,
google_drive,
vault,
web_crawler,
trace,
microsoft_outlook,
microsoft_teams,
granola,
fathom,
fireflies,
figma,
linear,
hubspot,
salesforce,
coda,
confluence,
jira,
metabase,
gong,
clickup,
lightfield,
pylon,
fellow,
odoo,
external_mcp,
page
resource_id
string
required
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
pending_review,
skipped,
filtered,
cancelled