Docs

listFilePassages

List passages for a file

GET/v1/files/{id}/passages

Authorization

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

Header parameters

x-bot-idstring
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

idstring
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

Returns the list of passages extracted from a file.

passagesobject[]
metaobject