Memory
Store a memory
Learn about how to ingest content and the receipt you get back
Send the text you want remembered. The API queues it and returns a receipt at once; the write is stored, checked and promoted in the background.
POST/v1/ingesthttps://api.neurophic.ai
Request
identifier
string required 1-500 characters
Your end-user id.
name
string1-100 characters
Optional display name for the identifier, shown in the console and used as context when memories are processed. 1-100 characters, no line breaks.
content
string required 1-10,000 characters
The text to remember. 1-10,000 characters.
metadata
object
Optional metadata. Only
topic is accepted; unknown keys are rejected.topic
'work' | 'personal'
Optional category used when memories are clustered into patterns: 'personal' (about the user) or 'work' (projects, goals, tasks).
Note
Ingest is the only call that creates the identifier record; reads and deletes never do.name sets the identifier's display name; Get started > Identifiers covers both.Response
202Success
id
string required
Receipt id. Becomes the memory id once the write is processed.
status
string required
Always 'queued': the write is accepted and processed in the background.
Failures return one of the errors listed under API reference > Errors.
{
"id": "5f1d2c3e-0c2a-4b7e-9a1b-2f3c4d5e6f70",
"status": "queued"
}
Warning
A202 means the write was accepted, not that it was stored. Processing can still drop it without reporting an error:- the content is a near-duplicate of an existing memory;
- the identifier has reached its stored-memory cap;
- the identifier is being erased.
Note
- The receipt id is the short-term observation. Processing later extracts facts from it and stores them as new long-term memories with their own ids. The observation is removed about 48 hours after promotion, so the receipt id eventually returns
404while the memories derived from it remain. Find those with Retrieve or List. - Deleting the receipt id with Delete removes the observation only; facts already promoted from it stay.
Example
import { Neurophic } from 'neurophic';
const client = new Neurophic({ apiKey: process.env.NEUROPHIC_API_KEY });
const { id, status } = await client.ingest({
identifier: 'user-123',
name: 'Jane Doe',
content: 'Prefers window seats and vegetarian meals on long flights.',
metadata: { topic: 'personal' },
});
curl https://api.neurophic.ai/v1/ingest \
-H "Authorization: Bearer nph_..." \
-H "Content-Type: application/json" \
-d '{
"identifier": "user-123",
"name": "Jane Doe",
"content": "Prefers window seats and vegetarian meals on long flights.",
"metadata": { "topic": "personal" }
}'