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: <x-bot-id>'
{
  "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.

Headers

x-bot-id
string
required

Bot id

x-integration-id
string

Integration id

x-integration-alias
string

Integration alias

x-integration-name
string

Integration name

x-user-id
string

User Id

x-user-role
string

User Role

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