foldersPassages

List Passages For Folder

List all passages associated with a data folder.

Path parameters

folder_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

beforestring or nullOptional
Passage ID cursor for pagination. Returns passages that come before this passage ID in the specified sort order
afterstring or nullOptional
Passage ID cursor for pagination. Returns passages that come after this passage ID in the specified sort order
limitinteger or nullOptionalDefaults to 100
Maximum number of passages to return
orderenumOptionalDefaults to desc
Sort order for passages by creation time. 'asc' for oldest first, 'desc' for newest first
Allowed values:
order_by"created_at"OptionalDefaults to created_at
Field to sort by

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.
archive_idstring or null
The unique identifier of the archive containing this 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.
tagslist of strings or null
Tags associated with this passage.
idstring or nullformat: "^passage-[a-fA-F0-9]{8}"

The human-friendly ID of the Passage

Errors