AgentsPassages

Create Passage

Insert a memory into an agent's archival memory store.

Path parameters

agent_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
textstringRequired
Text to write to archival memory.

Response

Successful Response
textstring
The text of the passage.
created_by_idstring or null
The id of the user that made this object.
last_updated_by_idstring or null
The id of the user that made this object.
created_atstring or nullformat: "date-time"
The creation date of the passage.
updated_atstring or nullformat: "date-time"
The timestamp when the object was last updated.
is_deletedboolean or nullDefaults to false
Whether this passage is deleted or not.
agent_idstring or null
The unique identifier of the agent associated with the passage.
source_idstring or null
The data source of the passage.
file_idstring or null
The unique identifier of the file associated with the passage.
file_namestring or null

The name of the file (only for source passages).

metadataobject or null
The metadata of the passage.
idstring or nullformat: "^passage-[a-fA-F0-9]{8}"

The human-friendly ID of the Passage

embeddinglist of integers or null
The embedding of the passage.
embedding_configobject or null
The embedding configuration used by the passage.