Skip to main content
POST
Run Extract Template

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

Response

Successful Response

data
object
required
metadata
object
required
status
enum<string>
required

The status of the task.

Available options:
success,
skipped,
fatal,
error,
postponed,
ignored,
rejected,
blocked
task_id
string
required

Unique identifier for the task.

url
string
required

The final URL.

debug
object
pagination
object

Pagination information if applicable.

status_code
number

The HTTP status code of the task.

warnings
string[]

List of warnings generated during the task.