Skip to main content

Overview

List Private Documents returns a paginated, filterable list of document metadata from the private corpus. Use it to see what documents exist — by connector, origin, tags, date, or file name — before reading or searching content.

When to Use

List Private Documents is ideal for:
  • Recent uploads: Checking what was added yesterday, this week, or since a given date
  • Connector browsing: Listing the latest files from a specific email, broker research, or SharePoint connector
  • Tag-based inventory: Finding documents that carry broker, sender, recipient, or custom tags
  • Id resolution: Locating a document_id to pass to bigdata_fetch_document
This tool returns metadata for navigation. For relevance-ranked content retrieval, use bigdata_search. To read one document end-to-end, use bigdata_fetch_document.

How It Works

  1. Optionally resolve a connector_id with bigdata_list_connectors
  2. Optionally confirm tags with bigdata_list_tags
  3. Call bigdata_list_documents with the relevant filters and pagination
  4. Use returned ids to fetch full text or follow up with search

Parameters

Important Notes

  • Combine connector and tags to narrow results within a single source (for example, emails from a specific sender)
  • A full page of results usually means more pages are available — advance page to continue
  • File management actions such as rename, delete, sharing changes, or uploading originals of any type or size are handled at https://app.bigdata.com/files

Data Returned

An array of document summaries. Each includes:

Practical Tips

Large result sets

Summarize before listing every row — for example, highlight the five most recent documents and offer to narrow by tag, date, or file name.

Auto-tags

Surface notable auto-tags from each document’s tags field (broker:, from:, to:, label:) to make corpus organisation clear when presenting results.

Next steps

Once the right document is identified, use bigdata_fetch_document for the full text, or bigdata_search for relevance-ranked synthesis across multiple files.