POST
/
{workspaceId}
/
files
/
extract
/
structuredData
{
  "operationId": "aaaabbbCCCCdddd",
  "status": "completed",
  "result": {
    "firstName": "John",
    "lastName": "Doe",
    "jobTitle": "Manager"
  }
}

Authorizations

​
x-api-key
string
headerrequired

API Key used to authenticate your requests. How to create one.

Path Parameters

​
workspaceId
string
required

Your workspace ID. How to find it?

Body

application/json

The request to extract structured data from file

​
file
object
required

Image file data to extract from

​
dataSchema
object
required

The schema (in JSONSchema) to which the extracted data should conform to. More about JSONSchema

​
strategy
object

The strategy to extract structured data from a file. Includes the model and type of extraction.

​
prompt
string

Prompt given to the AI model to help with extraction.

Response

200 - application/json

Successful file extraction result

​
result
any
required

The extracted data formatted according to the input dataSchema

​
operationId
string
required

Operation ID.

​
status
enum<string>
required

Operation status.

Available options:
completed
Standalone File API OverviewExtract Structured Data - Async Start