listFilePassages

List passages for a file

GET /v1/files/{id}/passages

cURL

cURL

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

200

{
  "passages": [
    {
      "id": "<string>",
      "content": "<string>",
      "meta": {
        "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

pageSize · integer

Number of items to return per page (default 20, max 100)

limit · number

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

Response

200

application/json

Returns the list of passages extracted from a file.

passages · object[] · required

Show child attributes

meta · object · required

Show child attributes