Sections

The indexed sections (chunks) a document was split into.

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

List a document's sections

GET/v1/{knowledge_id}/documents/{object_id}/chunks

Retrieve chunks for a specific document with pagination and optional metadata. Includes chunk-level metadata: chunk_keywords, chunk_topic, chunk_entities.

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

Path parameters

Name	Type	Description
`knowledge_id`required	`string`
`object_id`required	`string`	Document Object ID

Query parameters

Name	Type	Description
`limit`	`integer`	Number of chunks to returnDefault: 20
`offset`	`integer`	Offset for paginationDefault: 0
`metadata`	`boolean`	Include chunk metadata in responseDefault: false

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.get(
    f"{API_ROOT}/v1/YOUR_COLLECTION_ID/documents/YOUR_DOCUMENT_ID/chunks",
    headers={"x-api-key": API_KEY},
    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/documents/YOUR_DOCUMENT_ID/chunks`, {
  method: "GET",
  headers: { "x-api-key": process.env.DOCUMENT_INTELLIGENCE_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X GET "https://futuresmart.ai/document-intelligence/api/v1/YOUR_COLLECTION_ID/documents/YOUR_DOCUMENT_ID/chunks" \
  -H "x-api-key: $DOCUMENT_INTELLIGENCE_API_KEY"

Get a section

GET/v1/{knowledge_id}/chunks/{chunk_id}

Retrieve a single chunk by its ID. Response includes chunk metadata.

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

Path parameters

Name	Type	Description
`knowledge_id`required	`string`
`chunk_id`required	`string`	Chunk ID

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.get(
    f"{API_ROOT}/v1/YOUR_COLLECTION_ID/chunks/YOUR_CHUNK_ID",
    headers={"x-api-key": API_KEY},
    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/chunks/YOUR_CHUNK_ID`, {
  method: "GET",
  headers: { "x-api-key": process.env.DOCUMENT_INTELLIGENCE_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X GET "https://futuresmart.ai/document-intelligence/api/v1/YOUR_COLLECTION_ID/chunks/YOUR_CHUNK_ID" \
  -H "x-api-key: $DOCUMENT_INTELLIGENCE_API_KEY"

Get many sections

POST/v1/{knowledge_id}/chunks/batch

Retrieve multiple chunks by their IDs in batch. Response includes chunk metadata.

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

Path parameters

Name	Type	Description
`knowledge_id`required	`string`

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/chunks/batch",
    headers={"x-api-key": API_KEY},
    json=["string"],
    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/chunks/batch`, {
  method: "POST",
  headers: { "x-api-key": process.env.DOCUMENT_INTELLIGENCE_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify([
    "string"
  ]),
});
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/chunks/batch" \
  -H "x-api-key: $DOCUMENT_INTELLIGENCE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    "string"
  ]'

Example request body

JSON

[
  "string"
]

Get a section's fields

GET/v1/{knowledge_id}/chunks/{chunk_id}/metadata

Return chunk-level metadata only (no text). Dynamically returns all chunk-level metadata fields based on field configurations. Excludes system fields like object_id, knowledge_id, user_id, sub_object_id, and chunk_text.

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

Path parameters

Name	Type	Description
`knowledge_id`required	`string`
`chunk_id`required	`string`	Chunk ID

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.get(
    f"{API_ROOT}/v1/YOUR_COLLECTION_ID/chunks/YOUR_CHUNK_ID/metadata",
    headers={"x-api-key": API_KEY},
    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/chunks/YOUR_CHUNK_ID/metadata`, {
  method: "GET",
  headers: { "x-api-key": process.env.DOCUMENT_INTELLIGENCE_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
console.log(await res.json());

curl -X GET "https://futuresmart.ai/document-intelligence/api/v1/YOUR_COLLECTION_ID/chunks/YOUR_CHUNK_ID/metadata" \
  -H "x-api-key: $DOCUMENT_INTELLIGENCE_API_KEY"