Submit a new batch of documents for processing

Submit a new batch of documents for processing. For more information, see: Processing Documents Guide.

Authorization

x-api-key<token>

In: header

Scope: api_key

Request Body

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.eu-west-2.amazonaws.com/my-bucket/my-object?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20130524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20130524T000000Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=b59cfa898d8b4c4e4355b2f9a98fb8c145dda827c92d9ac34897f0554d1e5bf4",
        "fileId": "file1234",
        "categoryHint": "FUEL",
        "meta": {
          "key": "value"
        }
      }
    ],
    "type": "url",
    "batchId": "11111111-1111-1111-1111-111111111111",
    "meta": {
      "key": "value"
    }
  }'

curl -X POST "https://api.aws-au.carbonapi.io/document/batch" \  -H "Content-Type: application/json" \  -d '{    "documents": [      {        "fileUrl": "https://s3.eu-west-2.amazonaws.com/my-bucket/my-object?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20130524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20130524T000000Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=b59cfa898d8b4c4e4355b2f9a98fb8c145dda827c92d9ac34897f0554d1e5bf4",        "fileId": "file1234",        "categoryHint": "FUEL",        "meta": {          "key": "value"        }      }    ],    "type": "url",    "batchId": "11111111-1111-1111-1111-111111111111",    "meta": {      "key": "value"    }  }'

{
  "batchId": "11111111-1111-1111-1111-111111111111"
}