listFilePassages

List passages for a file

GET/v1/files/{id}/passages

Authorization

AuthorizationBearerrequired

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

Header parameters

x-bot-idstringrequired

Bot id

x-integration-idstring

Integration id

x-integration-aliasstring

Integration alias

x-integration-namestring

Integration name

x-user-idstring

User Id

x-user-rolestring

User Role

Path parameters

idstringrequired

File ID or Key

Query parameters

nextTokenstring

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

limitnumber

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

Response

Returns the list of passages extracted from a file.

passagesobject[]required

metaobjectrequired

Request

curl --request GET \ \
  --url https://api.botpress.cloud/v1/files/{id}/passages \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "passages": [
    {
      "id": "string",
      "content": "string",
      "meta": {
        "type": "chunk",
        "subtype": "title",
        "pageNumber": 0,
        "position": 0,
        "sourceUrl": "https://example.com"
      }
    }
  ],
  "meta": {
    "nextToken": "string"
  }
}