Files APIs
Extract Structured Data - Sync
Extracts 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.
POST
/
{workspaceId}
/
files
/
extract
/
structuredData
Authorizations
x-api-key
string
headerrequiredAPI Key used to authenticate your requests. How to create one.
Path Parameters
workspaceId
string
requiredYour workspace ID. How to find it?
Body
application/json
The request to extract structured data from file
dataSchema
object
requiredThe schema (in JSONSchema) to which the extracted data should conform to. More about JSONSchema
file
object
requiredImage file data to extract from
prompt
string
Prompt given to the AI model to help with extraction.
strategy
object
The strategy to extract structured data from a file. Includes the model and type of extraction.
Response
200 - application/json
Successful file extraction result
result
any
requiredThe extracted data formatted according to the input dataSchema
operationId
string
requiredOperation ID.
status
enum<string>
requiredOperation status.
Available options:
completed