Document AI — DMS

Search documents (full-text)

Full-text and hybrid document search within the workspace you provide.

get/documents/document-search

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/documents/document-search
  • Auth: HTTP bearer

Query parameters

querystring required

Search term (full text, semantic vector, or hybrid keyword+vector).

workspace_idinteger required

Workspace ID to scope the search (required for single-workspace search).

search_mode'intelligent' | 'fulltext' | 'semantic' | 'hybrid' | 'exact'

Search strategy: intelligent (auto), fulltext, semantic, hybrid, or exact field match (exact requires field_key).

modestring

Legacy alias for search_mode (same values).

search_scope'current' | 'all'

current = only the workspace in workspace_id; all = all workspaces the bearer may access.

search_preference'keyword' | 'semantic' | 'balanced'

Bias when mode=intelligent: keyword (BM25), semantic (vectors), or balanced (default).

field_keystring

Meta-field key for exact mode (required when search_mode=exact).

limitinteger

Maximum results (default 20, max 100).

pageinteger

1-based page number for paginated results.

localestring

Optional locale hint for query normalization (e.g. de:DE).

workspace_idsinteger[]

Explicit list of workspace IDs (Alternative to search_scope=all).

include_meta_fieldsboolean

Include matched meta-field snippets in each hit.

include_ocr_previewboolean

Include short OCR text previews (larger payload).

similarity_thresholdnumber

Minimum semantic similarity score (0.0–1.0, default 0.5).

multi_vectorstring

Advanced: restrict embedding types used in semantic leg (comma-separated).

vector_weightnumber

Hybrid mode: semantic leg weight (0.0–1.0).

bm25_weightnumber

Hybrid mode: keyword/BM25 leg weight (0.0–1.0).

Response

Success

_scope_decisionstring
ai_dms_filterstring
countinteger
localestring
messagestring
processing_timestring
statusstring
totalinteger

Changes

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