API ReferenceDocument Analysis
Submit a new batch of documents for processing
Submit a new batch of documents for processing. For more information, see: Processing Documents Guide.
x-api-key<token>
In: header
Scope: api_key
documentsarray<DocumentDTO>
The documents to create a batch with
typestring
The type of submission you are performing - for now just URL is supported.
batchIdstring
An optional batchId for your own reconciliation.
metaobject
An optional meta object for your own reconciliation.
Empty Object
Response Body
curl -X POST "https://api.aws-au.carbonapi.io/document/batch" \ -H "Content-Type: application/json" \ -d '{ "documents": [ { "fileUrl": "https://s3.amazonaws.com/example/example.pdf?X-AMZ-Signature=example", "fileId": "file1234", "categoryHint": "FUEL", "meta": { "key": "value" } } ], "type": "url", "batchId": "11111111-1111-1111-1111-111111111111", "meta": { "key": "value" } }'{
"batchId": "11111111-1111-1111-1111-111111111111"
}