Files

Find a document by what it says

Searches the text of the files this account has filed and of the mail its connected mailboxes received, and answers with the documents and the messages rather than with prose: each match carries the passage it was found in and where to go to see it, so every hit is checkable against the source itself.

Only ever this account’s own folder, which holds both. A search is narrowed to the account’s own folder in the index and every passage that comes back is checked against the same folder again here, so a document belonging to another portfolio cannot be reached whatever the index returns.

A document the account has since deleted is never returned, even while the index still holds it. Where nothing is indexed at all, trouble says so: an empty matches on its own does not mean the filing has nothing in it.

get/api/v1/documents/search

Request

  • Base URL: http://localhost:5180
  • URL: http://localhost:5180/api/v1/documents/search
  • Auth: API key in cookie better-auth.session_token

Query parameters

qstring required

What to look for, in plain language. It is matched against what the documents say, not against their names.

limitinteger

How many documents to answer with, best first. 1 to 20, default 8.

Response

What the filing says, best first.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.