Extract

POST

Upload one or more files along with a prompt to extract data. The API processes the files based on the prompt and returns the extracted information.

A PDF may generate an array of many extracted JSON blobs, 1 per page for example.

Request

This endpoint expects a multipart form with multiple files.
filesfilesRequired
promptstringOptional

Instruction for data extraction. Like “focus on the colors of the images in this document” or “only focus on extracting addresses”

Response

Successful Response

extractionslist of objects
usageobject

Usage statistics for the request. A request goes through the BoundaryML pipeline, where documents can be converted into images. In the process, the number of characters consumed, produced, and the number of megapixels consumed are tracked.

request_idstring

Unique identifier for the request.

Errors