---
title: "Search documents (full-text)"
method: GET
path: "/documents/document-search"
tags: ["Document AI — DMS"]
---

# Search documents (full-text)

`GET /documents/document-search`

## Request

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

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

## Query parameters

- `query` string, required
- `workspace_id` integer, required
- `search_mode` 'intelligent' | 'fulltext' | 'semantic' | 'hybrid' | 'exact'
- `mode` string
- `search_scope` 'current' | 'all'
- `search_preference` 'keyword' | 'semantic' | 'balanced'
- `field_key` string
- `limit` integer
- `page` integer
- `locale` string
- `workspace_ids` integer[]
- `include_meta_fields` boolean
- `include_ocr_preview` boolean
- `similarity_threshold` number
- `multi_vector` string
- `vector_weight` number
- `bm25_weight` number

## Response `200`

Success

- object: Search documents (full text + metadata)
  - `_billing` object
    - `credits` object
      - `total_monthly` integer
      - `remaining_monthly` integer
      - `credit_source` string
      - `api_handler` string
      - `tier_info` object
        - `tier` string
        - `name` string
        - `initial_credits` integer
        - `price_monthly` integer
        - `price_overage_per_credit` integer
      - `notice` string
      - `renewal_days` integer
      - `subscription_status` string
    - `job` object
      - `api_job_name` string
      - `app` string
      - `action` string
      - `default_credits` integer
      - `credits_billed` integer
      - `pricing` object
        - `credits_per_unit` integer
        - `unit` string
        - `unit_count` integer
        - `addons` string
    - `requests` object
      - `limits` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `current` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `remaining` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `next_possible_request_seconds` integer
    - `remaining_credits` integer
    - `total_monthly` integer
    - `account_id` integer
    - `plan` object
      - `tier` string
      - `name` string
    - `credits_billed` integer
  - `_evidence_summary` unknown[]
    - unknown
  - `_scope_decision` string
  - `_search_quality` object
    - `query` string
    - `search_mode` string
    - `scope` string
    - `total_matching` integer
    - `returned_count` integer
    - `relevance_min` integer
    - `relevance_max` integer
    - `relevance_avg` integer
    - `strong_hits` integer
    - `weak_hits` integer
  - `ai_dms_filter` string
  - `count` integer
  - `documents` unknown[]
    - unknown
  - `locale` string
  - `locale_contract` object
    - `bcp47` string
    - `raw` string
  - `message` string
  - `pagination` object
    - `page` integer
    - `limit` integer
    - `total` integer
    - `total_pages` integer
  - `processing_time` string
  - `results` unknown[]
    - unknown
  - `search` object
    - `mode` string
    - `query` string
    - `query_original` string
    - `query_variants` unknown[]
      - unknown
    - `query_normalized` boolean
    - `workspace_filter` unknown[]
      - unknown
    - `execution_time_ms` number
    - `fulltext_matches` integer
    - `filename_only_mode` boolean
  - `search_stats` object
    - `mode` string
    - `query` string
    - `query_original` string
    - `query_variants` unknown[]
      - unknown
    - `query_normalized` boolean
    - `workspace_filter` unknown[]
      - unknown
    - `execution_time_ms` number
    - `fulltext_matches` integer
    - `filename_only_mode` boolean
  - `status` string
  - `total` integer

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)