Extract

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.

post/extract

Request

  • Base URL
    https://api2.boundaryml.com/v3
  • URL
    https://api2.boundaryml.com/v3/extract
  • Auth
    HTTP bearer

Request body multipart/form-data

filesstring[] required

One or more files to be processed.

promptstring

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

Response

Successful Response

request_idstring required

Unique identifier for the request.

Changes

No recorded changes to this operation across all 2 revisions of this API.