Extract document

You can use this endpoint to upload a single file for processing, and return results synchronously. If results are not available in time, this endpoint will return a 408 Request Timeout.

📘
Don't forget your uploadId!
The uploadId is used to delete the document and results after if needed.

Generating extra results

The extraResults query parameter will generate extra extraction results for the uploaded document.

The extra results you can generate include:

FormFields: all Form Field values that are extracted from the document by Butler's general form field extraction
Tables: all Table values that are extracted from the document by Butler's general table extraction algorithm
LineBlocks: all Line Block values that are extracted from the document by Butler's general Line Block extraction algorithm

200

xxxxxxxxxx
# Ensure SDK is installed
# pip install butler-sdk
​
from butler import Client
​
# Get API Key from https://docs.butlerlabs.ai/reference/uploading-documents-to-the-rest-api#get-your-api-key
api_key = '<api-key>'
# Get Queue ID from https://docs.butlerlabs.ai/reference/uploading-documents-to-the-rest-api#go-to-the-model-details-page
queue_id = '<queue_id>'
​
response = Client(api_key).extract_file('example.pdf', queue_id)
print(response)

📘Don't forget your uploadId!

Generating extra results

200200

📘
Don't forget your uploadId!