v2

latestOpenAPI 3.1.02026-08-014610794.4 KB

tools

Extract Data

Extract data from files using a provided schema. Depending on the number of files, their size and type, and the complexity of the schema, the extraction may fail or take a while (up to multiple minutes) to complete so don't time out too early. Try making the schema less complex and/or passing less and/or smaller files.

post/api/v1/tools/extract-data

Request body

filePathsstring[] required

List of file paths (or file path prefixes to be more specifically) to extract data from. If is no file at the specified paths or no files whose paths have the specified path as a prefix, the path is ignored. Only the following content types are supported: {'image/webp', 'message/rfc822', 'application/pdf', 'image/jpeg', 'text/plain', 'image/gif', 'image/png', 'image/jpg'}. Files of other content types are ignored. A maximum of 1 000 files can be passed to the extraction. IMPORTANT: A file path may match multiple files so the supported number of file paths may be lower.

Response

Data extracted successfully

dataobject required