Search

Find the passages that match a query.

Base URL https://futuresmart.ai/document-intelligence/api · every request sends x-api-key. Samples read the key from DOCUMENT_INTELLIGENCE_API_KEY. All endpoints

Search a collection

POST/v1/{knowledge_id}/search

Search for chunks using semantic or hybrid search.

This endpoint is an improvement on /chunks/search from knowledge_retrieval.py.

Credential Document Intelligence API key (x-api-key)

Path parameters

Name	Type	Description
`knowledge_id`required	`string`

Request body · application/json

Name	Type	Description
`query`	`string \| null`	Search query text
`num_chunks`	`integer`	Number of chunks to returnDefault: 3
`object_ids`	`array<string> \| null`	Hard document scope. Omit or use null for the whole knowledge base; [] returns no chunks. Metadata filters are not supported by this endpoint.
`mode`	`string \| null`	Search mode: 'hybrid' or 'non_hybrid'Default: hybrid

Other responses

422 Validation Error

import os
import requests

API_ROOT = "https://futuresmart.ai/document-intelligence/api"
API_KEY = os.environ["DOCUMENT_INTELLIGENCE_API_KEY"]

r = requests.post(
    f"{API_ROOT}/v1/YOUR_COLLECTION_ID/search",
    headers={"x-api-key": API_KEY},
    json={
        "num_chunks": 3,
        "mode": "hybrid",
    },
    timeout=120,
)
r.raise_for_status()
print(r.json())

const API_ROOT = "https://futuresmart.ai/document-intelligence/api";

const res = await fetch(`${API_ROOT}/v1/YOUR_COLLECTION_ID/search`, {
  method: "POST",
  headers: { "x-api-key": process.env.DOCUMENT_INTELLIGENCE_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "num_chunks": 3,
    "mode": "hybrid"
  }),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X POST "https://futuresmart.ai/document-intelligence/api/v1/YOUR_COLLECTION_ID/search" \
  -H "x-api-key: $DOCUMENT_INTELLIGENCE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "num_chunks": 3,
    "mode": "hybrid"
  }'

Example request body

JSON

{
  "num_chunks": 3,
  "mode": "hybrid"
}