agentsPassages

Modify Passage

Modify a memory in the agent's archival memory store.

Path parameters

agent_idstringRequired
memory_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
idstringRequired
The unique identifier of the passage.
created_by_idstring or nullOptional
The id of the user that made this object.
last_updated_by_idstring or nullOptional
The id of the user that made this object.
created_atstring or nullOptionalformat: "date-time"
The timestamp when the object was created.
updated_atstring or nullOptionalformat: "date-time"
The timestamp when the object was last updated.
is_deletedbooleanOptionalDefaults to false
Whether this passage is deleted or not.
agent_idstring or nullOptional
The unique identifier of the agent associated with the passage.
source_idstring or nullOptional
The data source of the passage.
file_idstring or nullOptional
The unique identifier of the file associated with the passage.
file_namestring or nullOptional

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

metadata_map from strings to any or nullOptional
The metadata of the passage.
textstring or nullOptional
The text of the passage.
embeddinglist of doubles or nullOptional
The embedding of the passage.
embedding_configobject or nullOptional
The embedding configuration used by the passage.

Response

Successful Response
textstring
The text of the passage.
embeddinglist of doubles or null
The embedding of the passage.
embedding_configobject or null
The embedding configuration used by 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).

metadatamap from strings to any or null
The metadata of the passage.
idstring or nullformat: "^passage-[a-fA-F0-9]{8}"

The human-friendly ID of the Passage

Errors