Extract Document Data (POST)

Synchronously extracts unstructured file data using an intelligent ingestion template.

Resource

1/connect/document-ai-automation/actions/extract

Available Version

68.0

HTTP Methods

POST

JSON example

1{
2  "templateIdentifier": "InvoiceTemplate",
3  "file":{
4          "contentDocumentId":"068xx00000xxbc",
5          "data":"base64...",
6          "mimeType":"application/pdf"
7         }
8  "pageRange": "1-5",
9  "uploadMethod":"Manual"}

Properties

Property Name	Type	Description	Required
`templateIdentifier`	String	The template identifier (ID or developer name) of the target extraction template.	Required
`contentDocumentId`	String	The Salesforce ID of the ContentDocument record.	Required if data is empty.
`data`	String	Base64 encoded binary file string.	Required if contentDocumentId is empty.
`mimeType`	String	The file format identifier (for example, application/pdf).	Required if data is used.
`pageRange`	String	The targeted boundary range of pages to parse (for example, 1-5).	Required when `contentDocumentId` is provided.
`uploadMethod`	String	Specifies the processing tracking method. Available values are: `Manual` `Automatic`	Optional

Response Body for POST

Extract Document Data