Sign in

v36

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-091882241.2 MB
agents

Create Passage

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

post/v1/agents/{agent_id}/archival-memory

Path parameters

agent_idstring required

Request body

textstring required

Text to write to archival memory.

tagsstring[] nullable

Optional list of tags to attach to the memory.

created_atstring date-time nullable

Optional timestamp for the memory (defaults to current UTC time).

Response

Successful Response

created_by_idstring nullable

The id of the user that made this object.

last_updated_by_idstring nullable

The id of the user that made this object.

created_atstring date-time

The creation date of the passage.

updated_atstring date-time nullable

The timestamp when the object was last updated.

is_deletedboolean

Whether this passage is deleted or not.

archive_idstring nullable

The unique identifier of the archive containing this passage.

source_idstring nullable

The data source of the passage.

file_idstring nullable

The unique identifier of the file associated with the passage.

file_namestring nullable

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

metadataobject nullable

The metadata of the passage.

tagsstring[] nullable

Tags associated with this passage.

idstring

The human-friendly ID of the Passage

textstring required

The text of the passage.

embeddingnumber[] nullable required

The embedding of the passage.

Example response

[
  {
    "id": "passage-123e4567-e89b-12d3-a456-426614174000"
  }
]