Skip to main content
GET
List documents
Filter by status and paginate with offset and limit (default and maximum 100). The response total counts the returned page, not all matching workspace documents. Advance the offset by the number returned and stop when the page is shorter than the requested limit.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Query Parameters

status
string | null

Filter by processing status

limit
integer
default:100
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

documents
DocumentResponseSchema · object[]
required
limit
integer
required
offset
integer
required
total
integer
required