Skip to main content
GET
/
v1
/
files
/
{id}
/
passages
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/files/{id}/passages \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <api-key>'
{
  "passages": [
    {
      "id": "<string>",
      "content": "<string>",
      "meta": {
        "type": "chunk",
        "subtype": "title",
        "pageNumber": 123,
        "position": 123,
        "sourceUrl": "<string>"
      }
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
x-bot-id
string
header
required

Your bot ID.

Path Parameters

​
id
string
required

File ID or Key

Query Parameters

​
nextToken
string

Provide the meta.nextToken value provided in the last API response to retrieve the next page of results

​
limit
number

The maximum number of passages to return per request (optional, default: 20, max: 200).

Response

Returns the list of passages extracted from a file.

​
passages
object[]
required
​
meta
object
required