Search Documents

GET https://api.stax.ai/document/search

Search through your account to find documents that match the given query.

❗️

This endpoint does not search through your archives

The standard document search endpoint in Stax.ai only searches through your unarchived files. This is done to improve search performance across files that are used the most!

📘

Advanced Search Operators

Stax.ai supports advanced search queries using search operators! See below for options.

AND Operator

• '+' (plus sign) is used as an AND operator.
  Example: hello + world would require hello and world to be in the document, but not necessarily as a phrase. A document that had a sentence: Hello Lindsay, and another sentence: the world spins around its axis, would be returned.

OR Operator

• '|' (Shift + ) is used as an OR operator.
  Example: hello | world would return documents that have either hello or world.

NOT Operator

• '-' (minus sign) is used as a NOT operator.
  Example: hello -world would return documents that have hello, but cannot have world in it.

Phrase Match

• Quotes ("...") wrap a phrase to look for exact matches.
  Example: "hello world" would only return documents that have hello world in that order. The example in the AND operator will not be returned for a phrase match search.

Wildcards

• '' (asterisks) are used as a wildcard operator.
  Example: hel would return documents with help, hello, hell, etc.
  A useful example of this is to get a list of documents associated with certain account or invoice number prefixes.

Fuzziness

• The fuzzy operator '~' is used after a word if you don't know the exact spelling. This is very useful for names if they were misspelled in documents.
  Example: Lindsay~ would return documents with Lindsay and Lindsey. This is especially useful for my name because many people mistake the spelling!

Combining

• And of course, you can combine operators to form a complex query. You can use parentheses to group queries too!
  Example: Lindsay~ + ( receipt | invoice ) -aptus would return any of my personal (not related to Aptus) receipts or invoices.