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

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
dataSchema
object
required

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

file
object
required

Image 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
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