Docs
Open dashboard

List knowledge documents

GET/knowledge-base

Returns knowledge documents in this workspace, newest first. Filter by document_type, status, category, or free-text search. Not paywalled — reads are always available.

Requires Authorization: Bearer <api_key>. Create a key in the Inspra dashboard under Workspace Settings → API Keys.

Query parameters

  • pageinteger≥ 1optional
    1-based page index. Defaults to 1.
    Default 1
  • page_sizeinteger1–100optional
    Items per page. Defaults to 20. Hard-capped at 100 by the server.
    Default 20
  • searchstringoptional
    Case-insensitive substring match against title, description and content.
  • document_typestringoptional
    Filter by document type.
    documentfaqproduct_infopolicyscriptother
  • statusstringoptional
    Filter by document status.
    draftprocessingactivearchivederror
  • categorystringoptional
    Filter by category (exact match).

Response 200 OK

Paginated knowledge document list.

  • dataobject[]required
    15 fields
    • idstringuuidrequired
    • titlestring0–500 charsrequired
    • descriptionstringnullable0–2000 charsoptional
    • document_typestringrequired
      documentfaqproduct_infopolicyscriptother
    • statusstringrequired
      draftprocessingactivearchivederror
    • file_namestringnullableoptional
    • file_typestringnullableoptional
    • file_size_bytesintegernullableoptional
    • storage_pathstringnullableoptional
      Storage path returned from the upload-url endpoint.
    • tagsstring[]required
    • categorystringnullable0–255 charsoptional
    • usage_countintegerrequired
    • last_used_atstringnullabledate-timeoptional
    • created_atstringdate-timerequired
    • updated_atstringdate-timerequired
  • paginationobjectrequired
    Echoed pagination block on every list response. page and page_size match the request (or the defaults if omitted); total is the count of matching rows across all pages.
    3 fields
    • pageinteger≥ 1required
      1-based page index of this response.
    • page_sizeinteger≥ 1required
      Number of items per page (request cap is 100).
    • totalinteger≥ 0required
      Total matching items across all pages.

Errors

  • 400Bad Request
    Validation failed / malformed request.
  • 401Unauthorized
    Missing, malformed, or invalid API key.
  • 403Forbidden
    Workspace unavailable, suspended, or paywalled.
  • 429Too Many Requests
    Workspace request limit exceeded; shared across all its API keys.