Search Document Collection

Search across all documents in a document collection using the document metadata and contents.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
collectionIdUUIDRequired
searchQuerystringRequired
userEmailstringRequired

The email of the user making the search request for permissions reduction.

structuredQueryFilterslist of objectsOptional

The structured query filters to apply to the search query.

searchOptionsobjectOptional
metadataFilterExpressionstringOptionalDeprecated

Legacy metadata filter expression to apply to the search query. Use structuredQueryFilters instead.

Response

This endpoint returns an object.
searchTermsUsedlist of strings
structuredFiltersAppliedlist of objects
searchIdUUID
resultslist of objects