NInimbleway
Extraction Templates

POST /v2/extraction_templates/async

Changed on

Execute Extraction Template Async Endpoint

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v2/extraction_templates/async
  • Auth
    HTTP bearer

Request body

formatsstring[]

Response formats to include. All disabled by default.

localizationboolean
paramsobject required
templatestring required
callback_urlstring

URL to call back when async operation completes

storage_compressboolean

Whether to compress stored data

storage_object_namestring

Custom name for the stored object

storage_typestring

Type of storage to use for results

storage_urlstring

URL for storage location

Example request

{
  "formats": [
    "html",
    "markdown"
  ],
  "callback_url": "https://example.com/webhook/callback",
  "storage_compress": true,
  "storage_object_name": "result-2024-01-15.json",
  "storage_type": "s3",
  "storage_url": "s3://bucket-name/path/to/object"
}

Response

Async Task Created

status'success' required
taskobject required

Changes