Files APIs
Extract Structured Data - Async Start
Files APIs
Extract Structured Data - Async Start
Starts an asynchronous operation to extract structured data from a file. Supported file types are image, pdf (more coming soon!). It accepts the file and requested schema for the data to be extracted. It responds with an ID to track the operation status and retrieve the result.
POST
/
{workspaceId}
/
files
/
extract
/
structuredData
/
start
Authorizations
API Key used to authenticate your requests. How to create one.
Path Parameters
Your workspace ID. How to find it?
Body
application/json
The request to extract structured data from file
Image file data to extract from
The schema (in JSONSchema) to which the extracted data should conform to. More about JSONSchema
The strategy to extract structured data from a file. Includes the model and type of extraction.
Prompt given to the AI model to help with extraction.