> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agents.labs.bandwidth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List documents

> List knowledge-base documents and processing status.

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.


## OpenAPI

````yaml GET /api/v1/knowledge-base/documents
openapi: 3.1.0
info:
  title: Bandwidth Agent Builder API
  version: v1
  description: >-
    Manage agents, place calls, and retrieve conversation results in your
    workspace.
servers:
  - url: https://agents.labs.bandwidth.com
    description: Workspace API
security: []
paths:
  /api/v1/knowledge-base/documents:
    get:
      tags:
        - knowledge-base
      summary: List documents
      description: >-
        **Authorization:** Accepts a Labs OAuth bearer token or a Labs API key.
        Workspace-scoped resources require membership in the requested
        workspace.


        List knowledge-base documents and processing status.
      operationId: list_documents_api_v1_knowledge_base_documents_get
      parameters:
        - description: Filter by processing status
          in: query
          name: status
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by processing status
            title: Status
        - in: query
          name: limit
          required: false
          schema:
            default: 100
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - in: query
          name: offset
          required: false
          schema:
            default: 0
            minimum: 0
            title: Offset
            type: integer
        - description: >-
            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.
          in: header
          name: X-VOAI-ORGANIZATION-ID
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              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.
            title: X-Voai-Organization-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentListResponseSchema'
          description: Successful Response
        '400':
          description: Invalid request or missing/invalid workspace header with an API key.
        '401':
          description: Missing, invalid, or expired credential.
        '403':
          description: >-
            The account lacks access to the workspace, resource, or required
            role.
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - LabsAuth: []
        - LabsApiKey: []
components:
  schemas:
    DocumentListResponseSchema:
      properties:
        documents:
          items:
            $ref: '#/components/schemas/DocumentResponseSchema'
          title: Documents
          type: array
        limit:
          title: Limit
          type: integer
        offset:
          title: Offset
          type: integer
        total:
          title: Total
          type: integer
      required:
        - documents
        - total
        - limit
        - offset
      title: DocumentListResponseSchema
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    DocumentResponseSchema:
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        created_by:
          title: Created By
          type: integer
        custom_metadata:
          additionalProperties: true
          title: Custom Metadata
          type: object
        docling_metadata:
          additionalProperties: true
          title: Docling Metadata
          type: object
        document_uuid:
          title: Document Uuid
          type: string
        file_hash:
          title: File Hash
          type: string
        file_size_bytes:
          title: File Size Bytes
          type: integer
        filename:
          title: Filename
          type: string
        id:
          title: Id
          type: integer
        is_active:
          title: Is Active
          type: boolean
        mime_type:
          title: Mime Type
          type: string
        organization_id:
          title: Organization Id
          type: integer
        processing_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Processing Error
        processing_status:
          title: Processing Status
          type: string
        retrieval_mode:
          default: chunked
          title: Retrieval Mode
          type: string
        source_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Url
        total_chunks:
          title: Total Chunks
          type: integer
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - document_uuid
        - filename
        - file_size_bytes
        - file_hash
        - mime_type
        - processing_status
        - total_chunks
        - custom_metadata
        - docling_metadata
        - created_at
        - updated_at
        - organization_id
        - created_by
        - is_active
      title: DocumentResponseSchema
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    LabsAuth:
      description: >-
        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.
      scheme: bearer
      type: http
    LabsApiKey:
      description: >-
        Bandwidth Labs API key. Also send `X-VOAI-ORGANIZATION-ID` with a
        positive local workspace ID belonging to the key owner. Access follows
        the owner's current workspace role. Do not also send a bearer token. API
        keys cannot access bearer-only or Labs `super_user` operations.
      in: header
      name: X-BW-LABS-AGENTS-API-KEY
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.