Search Document Pages
curl --request POST \
--url https://api.fieldwise.ai/api/v1/documents/pages/search \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--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
}
'import requests
url = "https://api.fieldwise.ai/api/v1/documents/pages/search"
payload = {
"metadata_filter": { "$and": [{ "year": "2023" }, { "category": { "$in": ["finance", "earnings"] } }] },
"optimize_metadata": True,
"optimize_query": True,
"query": "Find information about revenue growth",
"top_k": 5
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata_filter: {$and: [{year: '2023'}, {category: {$in: ['finance', 'earnings']}}]},
optimize_metadata: true,
optimize_query: true,
query: 'Find information about revenue growth',
top_k: 5
})
};
fetch('https://api.fieldwise.ai/api/v1/documents/pages/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fieldwise.ai/api/v1/documents/pages/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'metadata_filter' => [
'$and' => [
[
'year' => '2023'
],
[
'category' => [
'$in' => [
'finance',
'earnings'
]
]
]
]
],
'optimize_metadata' => true,
'optimize_query' => true,
'query' => 'Find information about revenue growth',
'top_k' => 5
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fieldwise.ai/api/v1/documents/pages/search"
payload := strings.NewReader("{\n \"metadata_filter\": {\n \"$and\": [\n {\n \"year\": \"2023\"\n },\n {\n \"category\": {\n \"$in\": [\n \"finance\",\n \"earnings\"\n ]\n }\n }\n ]\n },\n \"optimize_metadata\": true,\n \"optimize_query\": true,\n \"query\": \"Find information about revenue growth\",\n \"top_k\": 5\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fieldwise.ai/api/v1/documents/pages/search")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata_filter\": {\n \"$and\": [\n {\n \"year\": \"2023\"\n },\n {\n \"category\": {\n \"$in\": [\n \"finance\",\n \"earnings\"\n ]\n }\n }\n ]\n },\n \"optimize_metadata\": true,\n \"optimize_query\": true,\n \"query\": \"Find information about revenue growth\",\n \"top_k\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fieldwise.ai/api/v1/documents/pages/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata_filter\": {\n \"$and\": [\n {\n \"year\": \"2023\"\n },\n {\n \"category\": {\n \"$in\": [\n \"finance\",\n \"earnings\"\n ]\n }\n }\n ]\n },\n \"optimize_metadata\": true,\n \"optimize_query\": true,\n \"query\": \"Find information about revenue growth\",\n \"top_k\": 5\n}"
response = http.request(request)
puts response.read_body{
"data": {
"pages": [
{
"document_id": 123,
"page_number": 123,
"content": "<string>",
"score": 123,
"document_metadata": {}
}
],
"optimized_query": "<string>",
"optimized_metadata": {}
},
"success": true,
"error": {
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"version": "1.0"
}
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}Documents
Search document pages (deprecated)
deprecated
POST
/
api
/
v1
/
documents
/
pages
/
search
Search Document Pages
curl --request POST \
--url https://api.fieldwise.ai/api/v1/documents/pages/search \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--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
}
'import requests
url = "https://api.fieldwise.ai/api/v1/documents/pages/search"
payload = {
"metadata_filter": { "$and": [{ "year": "2023" }, { "category": { "$in": ["finance", "earnings"] } }] },
"optimize_metadata": True,
"optimize_query": True,
"query": "Find information about revenue growth",
"top_k": 5
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata_filter: {$and: [{year: '2023'}, {category: {$in: ['finance', 'earnings']}}]},
optimize_metadata: true,
optimize_query: true,
query: 'Find information about revenue growth',
top_k: 5
})
};
fetch('https://api.fieldwise.ai/api/v1/documents/pages/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fieldwise.ai/api/v1/documents/pages/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'metadata_filter' => [
'$and' => [
[
'year' => '2023'
],
[
'category' => [
'$in' => [
'finance',
'earnings'
]
]
]
]
],
'optimize_metadata' => true,
'optimize_query' => true,
'query' => 'Find information about revenue growth',
'top_k' => 5
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fieldwise.ai/api/v1/documents/pages/search"
payload := strings.NewReader("{\n \"metadata_filter\": {\n \"$and\": [\n {\n \"year\": \"2023\"\n },\n {\n \"category\": {\n \"$in\": [\n \"finance\",\n \"earnings\"\n ]\n }\n }\n ]\n },\n \"optimize_metadata\": true,\n \"optimize_query\": true,\n \"query\": \"Find information about revenue growth\",\n \"top_k\": 5\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fieldwise.ai/api/v1/documents/pages/search")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata_filter\": {\n \"$and\": [\n {\n \"year\": \"2023\"\n },\n {\n \"category\": {\n \"$in\": [\n \"finance\",\n \"earnings\"\n ]\n }\n }\n ]\n },\n \"optimize_metadata\": true,\n \"optimize_query\": true,\n \"query\": \"Find information about revenue growth\",\n \"top_k\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fieldwise.ai/api/v1/documents/pages/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata_filter\": {\n \"$and\": [\n {\n \"year\": \"2023\"\n },\n {\n \"category\": {\n \"$in\": [\n \"finance\",\n \"earnings\"\n ]\n }\n }\n ]\n },\n \"optimize_metadata\": true,\n \"optimize_query\": true,\n \"query\": \"Find information about revenue growth\",\n \"top_k\": 5\n}"
response = http.request(request)
puts response.read_body{
"data": {
"pages": [
{
"document_id": 123,
"page_number": 123,
"content": "<string>",
"score": 123,
"document_metadata": {}
}
],
"optimized_query": "<string>",
"optimized_metadata": {}
},
"success": true,
"error": {
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"version": "1.0"
}
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}Authorizations
Headers
Body
application/json
The search query
Optional metadata filters using MongoDB-like query syntax
Filter by created_at database field. Supports operators: $eq, $ne, $gt, $lt, $gte, $lte, $in, $nin. Use ISO date format (e.g., '2024-01-01T00:00:00')
Filter by updated_at database field. Supports operators: $eq, $ne, $gt, $lt, $gte, $lte, $in, $nin. Use ISO date format (e.g., '2024-01-01T00:00:00')
Number of results to return
Required range:
1 <= x <= 1000If True, optimize the metadata filter based on the query
If True, optimize the query by removing parts covered by metadata filter
Response
Successful Response
Response data
Show child attributes
Show child attributes
Schema for API error responses.
Show child attributes
Show child attributes
Example:
{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}
Metadata for API responses
Show child attributes
Show child attributes
⌘I