POST
/
api
/
v1
/
documents
/
pages
/
search
curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/pages/search \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata_filter": {
    "$and": [
      {
        "year": "2023"
      },
      {
        "category": {
          "$in": [
            "finance",
            "earnings"
          ]
        }
      }
    ]
  },
  "optimize_metadata": true,
  "optimize_query": true,
  "query": "Find information about revenue growth",
  "top_k": 5
}'
{
  "success": true,
  "data": {
    "pages": [
      {
        "document_id": 123,
        "page_number": 123,
        "content": "<string>",
        "score": 123,
        "document_metadata": {}
      }
    ],
    "optimized_query": "<string>",
    "optimized_metadata": {}
  },
  "error": {
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0"
  }
}

Headers

​
X-API-Key
string | null

Body

application/json
​
query
string
required

The search query

​
metadata_filter
object | null

Optional metadata filters using MongoDB-like query syntax

​
top_k
integer
default:5

Number of results to return

Required range: 1 <= x <= 1000
​
optimize_metadata
boolean
default:false

If True, optimize the metadata filter based on the query

​
optimize_query
boolean
default:false

If True, optimize the query by removing parts covered by metadata filter

Response

200
application/json
Successful Response
​
data
object
required

Response data

​
success
boolean
default:true
​
error
object | null

Schema for API error responses.

Example:
{
  "error_code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found"
}
​
meta
object

Metadata for API responses