Skip to main content
POST
memory.add

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
scope
object
required

The memory set and optional end-user, agent or session within it.

messages
object[]
required

At most 50 messages, text or platform files.

Required array length: 1 - 50 elements
metadata
object

Custom fields; keys beginning with an underscore are reserved.

immutable
boolean
default:false

Keep these memories immutable where supported.

includes
string

What extraction should include.

Required string length: 1 - 2000
excludes
string

What extraction should exclude.

Required string length: 1 - 2000
instructions
string

Instructions for extracting user facts.

Required string length: 1 - 4000
agentInstructions
string

Instructions for extracting agent facts.

Required string length: 1 - 4000
categories
object

Category names and their descriptions.

graph
boolean

Request a distinct graph extraction effect where supported.

structuredSchema
object

A structured extraction schema, where its meaning is documented.

timestamp
integer

Unix seconds to backdate memories.

Required range: 0 <= x <= 9007199254740991
expirationDate
string<date>

Hide memories after this date; this does not erase them.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
temporalReasoning
boolean
default:false

Request temporal enrichment after extraction.

observationDate
string<date>

Date on which the messages were observed.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
observationTime
string<date-time>

Time at which the messages were observed.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
timezone
string

IANA time zone for interpreting observed times.

Required string length: 1 - 100
infer
boolean
default:false

Direct import stores text verbatim; extraction is a separate job.

Response

The result

results
object[]
required

The imported owned facts.