Sign in
Extraction Templates

Execute Extraction Template Realtime Endpoint

post/v2/extract/templates/run

Request body

formatsstring[]

Response formats to include. All disabled by default.

localizationboolean
paramsobject required
templatestring required

Example request

{
  "formats": [
    "html",
    "markdown"
  ]
}

Response

Successful Response

status'success' | 'skipped' | 'fatal' | 'error' | 'postponed' | 'ignored' | 'rejected' | 'blocked' required

The status of the task.

status_codenumber

The HTTP status code of the task.

task_idstring required

Unique identifier for the task.

urlstring required

The final URL.

warningsstring[]

List of warnings generated during the task.

Example response

{
  "data": {
    "network_capture": [
      {
        "filter": {
          "resource_type": "document"
        },
        "results": [
          {
            "request": {
              "resource_type": "document"
            }
          }
        ]
      }
    ]
  }
}

Changes

Changed in 1 of the 55 revisions of this API.1