curl --request GET \
--url https://api.botpress.cloud/v1/files/{id}/passages \
--header 'Authorization: Bearer <token>' \
--header 'x-bot-id: <x-bot-id>'{
"passages": [
{
"id": "<string>",
"content": "<string>",
"meta": {
"type": "chunk",
"subtype": "title",
"pageNumber": 123,
"position": 123,
"sourceUrl": "<string>"
}
}
],
"meta": {
"nextToken": "<string>"
}
}List passages for a file
curl --request GET \
--url https://api.botpress.cloud/v1/files/{id}/passages \
--header 'Authorization: Bearer <token>' \
--header 'x-bot-id: <x-bot-id>'{
"passages": [
{
"id": "<string>",
"content": "<string>",
"meta": {
"type": "chunk",
"subtype": "title",
"pageNumber": 123,
"position": 123,
"sourceUrl": "<string>"
}
}
],
"meta": {
"nextToken": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bot id
Integration id
Integration alias
Integration name
User Id
User Role
File ID or Key
Provide the meta.nextToken value provided in the last API response to retrieve the next page of results
The maximum number of passages to return per request (optional, default: 20, max: 200).
Returns the list of passages extracted from a file.
Show child attributes
Passage ID
The content of the passage.
The passage metadata.
Show child attributes
The type of passage
chunk, summary, consolidated, image The subtype of passage, if available.
title, subtitle, paragraph, blockquote, list, table, code, image, page Page number the passage is located on. Only applicable if the passage was extracted from a PDF file.
Position number of the passage in the file relative to the other passages, if available. Can be used to know the order of passages within a file.
The URL of the source file for the vector, if applicable (e.g. for image vectors).
Was this page helpful?