Sign in

v36

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

List Folder Passages

List all passages associated with a data folder.

get/v1/folders/{folder_id}/passages

Path parameters

folder_idstring required

Query parameters

beforestring nullable

Passage ID cursor for pagination. Returns passages that come before this passage ID in the specified sort order

Passage ID cursor for pagination. Returns passages that come before this passage ID in the specified sort order

afterstring nullable

Passage ID cursor for pagination. Returns passages that come after this passage ID in the specified sort order

Passage ID cursor for pagination. Returns passages that come after this passage ID in the specified sort order

limitinteger nullable

Maximum number of passages to return

Maximum number of passages to return

order'asc' | 'desc'

Sort order for passages by creation time. 'asc' for oldest first, 'desc' for newest first

Sort order for passages by creation time. 'asc' for oldest first, 'desc' for newest first

order_by'created_at'

Field to sort by

Field to sort by

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"
  }
]