Documents

Documents hold the extracted data from your uploaded files. Use these endpoints to retrieve document IDs, access extracted data, download original files, and manage documents.

Fetch Documents

GET https://api.koncile.ai/v1/fetch_documents

Fetches a list of all document IDs in your company.

Query parameters

start_date Date Optional Filter documents created on or after this date (format: YYYY-MM-DD)

end_date Date Optional Filter documents created on or before this date (format: YYYY-MM-DD)

Returns

An array of document IDs.

curl api.koncile.ai/v1/fetch_documents \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

# With date filters
curl "api.koncile.ai/v1/fetch_documents?start_date=2024-01-01&end_date=2024-12-31" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

import requests

response = requests.get(
    "https://api.koncile.ai/v1/fetch_documents",
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

# With date filters
response = requests.get(
    "https://api.koncile.ai/v1/fetch_documents",
    params={"start_date": "2024-01-01", "end_date": "2024-12-31"},
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch("https://api.koncile.ai/v1/fetch_documents", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.API_KEY}`
  }
});
const data = await response.json();

// With date filters
const filtered = await fetch(
  "https://api.koncile.ai/v1/fetch_documents?start_date=2024-01-01&end_date=2024-12-31",
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    }
  }
);
const filteredData = await filtered.json();

Fetch Document Data

GET https://api.koncile.ai/v1/fetch_document_data

Fetches the extracted data from a specific document.

Query parameters

document_id Integer Required The id of the document to fetch

Returns

document_id Integer The document identifier

template_id Integer The template used for extraction

document_name String Original filename

General_fields Object Fields extracted once per document, with values and confidence scores

General_fields_list Array Same general fields as a list format

Line_fields Object Fields extracted for each line item, with arrays of values and confidence scores

task_id String Associated task ID (if applicable)

curl api.koncile.ai/v1/fetch_document_data?document_id=123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

import requests

response = requests.get(
    "https://api.koncile.ai/v1/fetch_document_data",
    params={"document_id": 123},
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch(
  "https://api.koncile.ai/v1/fetch_document_data?document_id=123",
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    }
  }
);
const data = await response.json();

Fetch File

GET https://api.koncile.ai/v1/fetch_file

Downloads the original file associated with a document.

Query parameters

document_id Integer Conditional The document identifier. Required if task_id is not provided

task_id String Conditional The task identifier. Required if document_id is not provided

Provide either document_id OR task_id, but not both.

Returns

The file as a binary stream.

# Using document_id
curl api.koncile.ai/v1/fetch_file?document_id=123 \
  -H "Authorization: Bearer $API_KEY" \
  -o downloaded_file.pdf

# Using task_id
curl api.koncile.ai/v1/fetch_file?task_id=EOBdOSUX4Uv57YWsLYc4JQ \
  -H "Authorization: Bearer $API_KEY" \
  -o downloaded_file.pdf

import requests

# Using document_id
response = requests.get(
    "https://api.koncile.ai/v1/fetch_file",
    params={"document_id": 123},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

# Using task_id
response = requests.get(
    "https://api.koncile.ai/v1/fetch_file",
    params={"task_id": "EOBdOSUX4Uv57YWsLYc4JQ"},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

# Save to file
with open("downloaded_file.pdf", "wb") as f:
    f.write(response.content)

const fs = require("fs");

// Using document_id
const response = await fetch(
  "https://api.koncile.ai/v1/fetch_file?document_id=123",
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    }
  }
);

// Using task_id
const response = await fetch(
  "https://api.koncile.ai/v1/fetch_file?task_id=EOBdOSUX4Uv57YWsLYc4JQ",
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    }
  }
);

// Save to file
const buffer = await response.arrayBuffer();
fs.writeFileSync("downloaded_file.pdf", Buffer.from(buffer));

Fetch Files Batch

POST https://api.koncile.ai/v1/fetch_files_batch

Downloads multiple files at once and returns them as a ZIP archive.

Request body

document_ids Array[Integer] Conditional List of document IDs to download

task_ids Array[String] Conditional List of task IDs to resolve to documents

At least one of document_ids or task_ids must be provided. You can provide both to combine results.

Returns

A ZIP file containing all requested files.

curl -X POST api.koncile.ai/v1/fetch_files_batch \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"document_ids": [123, 124, 125]}' \
  -o documents.zip

import requests

response = requests.post(
    "https://api.koncile.ai/v1/fetch_files_batch",
    json={"document_ids": [123, 124, 125]},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

# Save to file
with open("documents.zip", "wb") as f:
    f.write(response.content)

const fs = require("fs");

const response = await fetch("https://api.koncile.ai/v1/fetch_files_batch", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${process.env.API_KEY}`
  },
  body: JSON.stringify({ document_ids: [123, 124, 125] })
});

// Save to file
const buffer = await response.arrayBuffer();
fs.writeFileSync("documents.zip", Buffer.from(buffer));

Delete Document

DELETE https://api.koncile.ai/v1/delete_doc

Removes a document from the system.

Query parameters

doc_id Integer Required The id of the document to delete

delete_file Boolean Optional If true, also deletes the underlying file. Default: false

Returns

Empty response on success.

# Delete document only
curl -X DELETE api.koncile.ai/v1/delete_doc?doc_id=123 \
  -H "Authorization: Bearer $API_KEY"

# Delete document and file
curl -X DELETE "api.koncile.ai/v1/delete_doc?doc_id=123&delete_file=true" \
  -H "Authorization: Bearer $API_KEY"

import requests

# Delete document only
response = requests.delete(
    "https://api.koncile.ai/v1/delete_doc",
    params={"doc_id": 123},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

# Delete document and file
response = requests.delete(
    "https://api.koncile.ai/v1/delete_doc",
    params={"doc_id": 123, "delete_file": True},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

// Delete document only
await fetch("https://api.koncile.ai/v1/delete_doc?doc_id=123", {
  method: "DELETE",
  headers: {
    "Authorization": `Bearer ${process.env.API_KEY}`
  }
});

// Delete document and file
await fetch("https://api.koncile.ai/v1/delete_doc?doc_id=123&delete_file=true", {
  method: "DELETE",
  headers: {
    "Authorization": `Bearer ${process.env.API_KEY}`
  }
});

PreviousInstructions NextAPI status codes

Last updated 1 month ago

Was this helpful?

hashtagFetch Documents

hashtagQuery parameters

hashtagReturns

hashtagFetch Document Data

hashtagQuery parameters

hashtagReturns

hashtagFetch File

hashtagQuery parameters

hashtagReturns

hashtagFetch Files Batch

hashtagRequest body

hashtagReturns

hashtagDelete Document

hashtagQuery parameters

hashtagReturns

Fetch Documents

Query parameters

Returns

Fetch Document Data

Query parameters

Returns

Fetch File

Query parameters

Returns

Fetch Files Batch

Request body

Returns

Delete Document

Query parameters

Returns