Skip to main content
POST
Run Extract Template (Async)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for executing an Extraction Template

params
object
required
template
string
required
formats
enum<string>[]

Response formats to include. All disabled by default.

Minimum array length: 1
Available options:
html,
markdown,
screenshot,
headers,
links
Example:
localization
boolean
default:false
callback_url
string

URL to call back when async operation completes

Example:

"https://example.com/webhook/callback"

storage_compress
boolean

Whether to compress stored data

Example:

true

storage_object_name
string

Custom name for the stored object

Example:

"result-2024-01-15.json"

storage_type
string

Type of storage to use for results

Example:

"s3"

storage_url
string

URL for storage location

Example:

"s3://bucket-name/path/to/object"

Response

200 - application/json

Async Task Created

status
string
required
Allowed value: "success"
task
object
required