v1

latestOpenAPI 3.0.3Proprietary2026-07-244065126.5 KB
Documents

Keyword Search

Performs keyword search across multiple documents and returns matches without positional information for faster response times.

Key Features:

  • Faster than batch search (no positional data retrieval)
  • Each match includes a unique match_id
  • Use match_id with the positional-info endpoint to get positions on demand
  • Supports same filtering and search options as batch search

Use Cases:

  • Initial search to find relevant documents quickly
  • When positional information is not immediately needed
  • Two-step workflow: search first, then get positions for specific matches

Workflow:

  1. Use this endpoint to quickly find matching documents
  2. Review results and identify matches of interest
  3. Call GET /api/v2/documents/search/positional-info with match_id for precise locations
post/api/v2/documents/keyword-search

Request body

keywordsstring[] required

List of keywords to search for (1-10 keywords)

Response

successboolean required

Whether the search was successful

total_hitsinteger required

Total number of matching documents (accurate based on fuzzy setting)

offsetinteger required

Current pagination offset

limitinteger required

Current page size limit

errorstring nullable

Error message if search failed