Extract Async

curl --request POST \
  --url https://sdk.nimbleway.com/v2/extract/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "auto_driver_configuration": {},
  "body": "<unknown>",
  "browser": "chrome",
  "browser_actions": [
    {
      "goto": "https://example.com/login"
    },
    {
      "wait_for_element": "#login-form"
    },
    {
      "fill": {
        "selector": "#username",
        "value": "[email protected]"
      }
    },
    {
      "fill": {
        "selector": "#password",
        "value": "password123"
      }
    },
    {
      "click": "#submit"
    },
    {
      "screenshot": {
        "full_page": true
      }
    }
  ],
  "city": "<string>",
  "consent_header": true,
  "cookies": [
    {
      "creation": "<string>",
      "domain": "<string>",
      "expires": "<string>",
      "extensions": [
        "<string>"
      ],
      "hostOnly": true,
      "httpOnly": true,
      "lastAccessed": "<string>",
      "maxAge": 123,
      "name": "<string>",
      "path": "<string>",
      "pathIsDefault": true,
      "secure": true,
      "value": "<string>"
    }
  ],
  "country": "US",
  "device": "desktop",
  "expected_status_codes": [
    0
  ],
  "formats": [],
  "headers": {},
  "http2": false,
  "is_xhr": false,
  "locale": "en-US",
  "markdown_backend": "full_page",
  "method": "GET",
  "network_capture": [
    {
      "resource_type": "document",
      "status_code": 349.5,
      "validation": false,
      "wait_for_requests_count": 0,
      "wait_for_requests_count_timeout": 123
    }
  ],
  "parse": false,
  "parser": {
    "myParser": {
      "option1": "value1"
    }
  },
  "referrer_type": "no-referrer",
  "render": true,
  "request_timeout": 2,
  "session": {
    "id": "<string>",
    "prefetch_userbrowser": false,
    "renew_on_blocked": false,
    "retry": false,
    "timeout": 123
  },
  "skill": "dynamic-content",
  "tag": "<string>",
  "callback_url": "<string>",
  "storage_compress": true,
  "storage_object_name": "<string>",
  "storage_type": "<string>",
  "storage_url": "<string>"
}
'

import requests

url = "https://sdk.nimbleway.com/v2/extract/async"

payload = {
    "url": "<string>",
    "auto_driver_configuration": {},
    "body": "<unknown>",
    "browser": "chrome",
    "browser_actions": [{ "goto": "https://example.com/login" }, { "wait_for_element": "#login-form" }, { "fill": {
                "selector": "#username",
                "value": "[email protected]"
            } }, { "fill": {
                "selector": "#password",
                "value": "password123"
            } }, { "click": "#submit" }, { "screenshot": { "full_page": True } }],
    "city": "<string>",
    "consent_header": True,
    "cookies": [
        {
            "creation": "<string>",
            "domain": "<string>",
            "expires": "<string>",
            "extensions": ["<string>"],
            "hostOnly": True,
            "httpOnly": True,
            "lastAccessed": "<string>",
            "maxAge": 123,
            "name": "<string>",
            "path": "<string>",
            "pathIsDefault": True,
            "secure": True,
            "value": "<string>"
        }
    ],
    "country": "US",
    "device": "desktop",
    "expected_status_codes": [0],
    "formats": [],
    "headers": {},
    "http2": False,
    "is_xhr": False,
    "locale": "en-US",
    "markdown_backend": "full_page",
    "method": "GET",
    "network_capture": [
        {
            "resource_type": "document",
            "status_code": 349.5,
            "validation": False,
            "wait_for_requests_count": 0,
            "wait_for_requests_count_timeout": 123
        }
    ],
    "parse": False,
    "parser": { "myParser": { "option1": "value1" } },
    "referrer_type": "no-referrer",
    "render": True,
    "request_timeout": 2,
    "session": {
        "id": "<string>",
        "prefetch_userbrowser": False,
        "renew_on_blocked": False,
        "retry": False,
        "timeout": 123
    },
    "skill": "dynamic-content",
    "tag": "<string>",
    "callback_url": "<string>",
    "storage_compress": True,
    "storage_object_name": "<string>",
    "storage_type": "<string>",
    "storage_url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    auto_driver_configuration: {},
    body: JSON.stringify('<unknown>'),
    browser: 'chrome',
    browser_actions: [
      {goto: 'https://example.com/login'},
      {wait_for_element: '#login-form'},
      {fill: {selector: '#username', value: '[email protected]'}},
      {fill: {selector: '#password', value: 'password123'}},
      {click: '#submit'},
      {screenshot: {full_page: true}}
    ],
    city: '<string>',
    consent_header: true,
    cookies: [
      {
        creation: '<string>',
        domain: '<string>',
        expires: '<string>',
        extensions: ['<string>'],
        hostOnly: true,
        httpOnly: true,
        lastAccessed: '<string>',
        maxAge: 123,
        name: '<string>',
        path: '<string>',
        pathIsDefault: true,
        secure: true,
        value: '<string>'
      }
    ],
    country: 'US',
    device: 'desktop',
    expected_status_codes: [0],
    formats: [],
    headers: {},
    http2: false,
    is_xhr: false,
    locale: 'en-US',
    markdown_backend: 'full_page',
    method: 'GET',
    network_capture: [
      {
        resource_type: 'document',
        status_code: 349.5,
        validation: false,
        wait_for_requests_count: 0,
        wait_for_requests_count_timeout: 123
      }
    ],
    parse: false,
    parser: {myParser: {option1: 'value1'}},
    referrer_type: 'no-referrer',
    render: true,
    request_timeout: 2,
    session: {
      id: '<string>',
      prefetch_userbrowser: false,
      renew_on_blocked: false,
      retry: false,
      timeout: 123
    },
    skill: 'dynamic-content',
    tag: '<string>',
    callback_url: '<string>',
    storage_compress: true,
    storage_object_name: '<string>',
    storage_type: '<string>',
    storage_url: '<string>'
  })
};

fetch('https://sdk.nimbleway.com/v2/extract/async', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sdk.nimbleway.com/v2/extract/async",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'auto_driver_configuration' => [
        
    ],
    'body' => '<unknown>',
    'browser' => 'chrome',
    'browser_actions' => [
        [
                'goto' => 'https://example.com/login'
        ],
        [
                'wait_for_element' => '#login-form'
        ],
        [
                'fill' => [
                                'selector' => '#username',
                                'value' => '[email protected]'
                ]
        ],
        [
                'fill' => [
                                'selector' => '#password',
                                'value' => 'password123'
                ]
        ],
        [
                'click' => '#submit'
        ],
        [
                'screenshot' => [
                                'full_page' => true
                ]
        ]
    ],
    'city' => '<string>',
    'consent_header' => true,
    'cookies' => [
        [
                'creation' => '<string>',
                'domain' => '<string>',
                'expires' => '<string>',
                'extensions' => [
                                '<string>'
                ],
                'hostOnly' => true,
                'httpOnly' => true,
                'lastAccessed' => '<string>',
                'maxAge' => 123,
                'name' => '<string>',
                'path' => '<string>',
                'pathIsDefault' => true,
                'secure' => true,
                'value' => '<string>'
        ]
    ],
    'country' => 'US',
    'device' => 'desktop',
    'expected_status_codes' => [
        0
    ],
    'formats' => [
        
    ],
    'headers' => [
        
    ],
    'http2' => false,
    'is_xhr' => false,
    'locale' => 'en-US',
    'markdown_backend' => 'full_page',
    'method' => 'GET',
    'network_capture' => [
        [
                'resource_type' => 'document',
                'status_code' => 349.5,
                'validation' => false,
                'wait_for_requests_count' => 0,
                'wait_for_requests_count_timeout' => 123
        ]
    ],
    'parse' => false,
    'parser' => [
        'myParser' => [
                'option1' => 'value1'
        ]
    ],
    'referrer_type' => 'no-referrer',
    'render' => true,
    'request_timeout' => 2,
    'session' => [
        'id' => '<string>',
        'prefetch_userbrowser' => false,
        'renew_on_blocked' => false,
        'retry' => false,
        'timeout' => 123
    ],
    'skill' => 'dynamic-content',
    'tag' => '<string>',
    'callback_url' => '<string>',
    'storage_compress' => true,
    'storage_object_name' => '<string>',
    'storage_type' => '<string>',
    'storage_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sdk.nimbleway.com/v2/extract/async"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"auto_driver_configuration\": {},\n  \"body\": \"<unknown>\",\n  \"browser\": \"chrome\",\n  \"browser_actions\": [\n    {\n      \"goto\": \"https://example.com/login\"\n    },\n    {\n      \"wait_for_element\": \"#login-form\"\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#username\",\n        \"value\": \"[email protected]\"\n      }\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#password\",\n        \"value\": \"password123\"\n      }\n    },\n    {\n      \"click\": \"#submit\"\n    },\n    {\n      \"screenshot\": {\n        \"full_page\": true\n      }\n    }\n  ],\n  \"city\": \"<string>\",\n  \"consent_header\": true,\n  \"cookies\": [\n    {\n      \"creation\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"expires\": \"<string>\",\n      \"extensions\": [\n        \"<string>\"\n      ],\n      \"hostOnly\": true,\n      \"httpOnly\": true,\n      \"lastAccessed\": \"<string>\",\n      \"maxAge\": 123,\n      \"name\": \"<string>\",\n      \"path\": \"<string>\",\n      \"pathIsDefault\": true,\n      \"secure\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"country\": \"US\",\n  \"device\": \"desktop\",\n  \"expected_status_codes\": [\n    0\n  ],\n  \"formats\": [],\n  \"headers\": {},\n  \"http2\": false,\n  \"is_xhr\": false,\n  \"locale\": \"en-US\",\n  \"markdown_backend\": \"full_page\",\n  \"method\": \"GET\",\n  \"network_capture\": [\n    {\n      \"resource_type\": \"document\",\n      \"status_code\": 349.5,\n      \"validation\": false,\n      \"wait_for_requests_count\": 0,\n      \"wait_for_requests_count_timeout\": 123\n    }\n  ],\n  \"parse\": false,\n  \"parser\": {\n    \"myParser\": {\n      \"option1\": \"value1\"\n    }\n  },\n  \"referrer_type\": \"no-referrer\",\n  \"render\": true,\n  \"request_timeout\": 2,\n  \"session\": {\n    \"id\": \"<string>\",\n    \"prefetch_userbrowser\": false,\n    \"renew_on_blocked\": false,\n    \"retry\": false,\n    \"timeout\": 123\n  },\n  \"skill\": \"dynamic-content\",\n  \"tag\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"storage_compress\": true,\n  \"storage_object_name\": \"<string>\",\n  \"storage_type\": \"<string>\",\n  \"storage_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sdk.nimbleway.com/v2/extract/async")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"auto_driver_configuration\": {},\n  \"body\": \"<unknown>\",\n  \"browser\": \"chrome\",\n  \"browser_actions\": [\n    {\n      \"goto\": \"https://example.com/login\"\n    },\n    {\n      \"wait_for_element\": \"#login-form\"\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#username\",\n        \"value\": \"[email protected]\"\n      }\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#password\",\n        \"value\": \"password123\"\n      }\n    },\n    {\n      \"click\": \"#submit\"\n    },\n    {\n      \"screenshot\": {\n        \"full_page\": true\n      }\n    }\n  ],\n  \"city\": \"<string>\",\n  \"consent_header\": true,\n  \"cookies\": [\n    {\n      \"creation\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"expires\": \"<string>\",\n      \"extensions\": [\n        \"<string>\"\n      ],\n      \"hostOnly\": true,\n      \"httpOnly\": true,\n      \"lastAccessed\": \"<string>\",\n      \"maxAge\": 123,\n      \"name\": \"<string>\",\n      \"path\": \"<string>\",\n      \"pathIsDefault\": true,\n      \"secure\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"country\": \"US\",\n  \"device\": \"desktop\",\n  \"expected_status_codes\": [\n    0\n  ],\n  \"formats\": [],\n  \"headers\": {},\n  \"http2\": false,\n  \"is_xhr\": false,\n  \"locale\": \"en-US\",\n  \"markdown_backend\": \"full_page\",\n  \"method\": \"GET\",\n  \"network_capture\": [\n    {\n      \"resource_type\": \"document\",\n      \"status_code\": 349.5,\n      \"validation\": false,\n      \"wait_for_requests_count\": 0,\n      \"wait_for_requests_count_timeout\": 123\n    }\n  ],\n  \"parse\": false,\n  \"parser\": {\n    \"myParser\": {\n      \"option1\": \"value1\"\n    }\n  },\n  \"referrer_type\": \"no-referrer\",\n  \"render\": true,\n  \"request_timeout\": 2,\n  \"session\": {\n    \"id\": \"<string>\",\n    \"prefetch_userbrowser\": false,\n    \"renew_on_blocked\": false,\n    \"retry\": false,\n    \"timeout\": 123\n  },\n  \"skill\": \"dynamic-content\",\n  \"tag\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"storage_compress\": true,\n  \"storage_object_name\": \"<string>\",\n  \"storage_type\": \"<string>\",\n  \"storage_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sdk.nimbleway.com/v2/extract/async")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"auto_driver_configuration\": {},\n  \"body\": \"<unknown>\",\n  \"browser\": \"chrome\",\n  \"browser_actions\": [\n    {\n      \"goto\": \"https://example.com/login\"\n    },\n    {\n      \"wait_for_element\": \"#login-form\"\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#username\",\n        \"value\": \"[email protected]\"\n      }\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#password\",\n        \"value\": \"password123\"\n      }\n    },\n    {\n      \"click\": \"#submit\"\n    },\n    {\n      \"screenshot\": {\n        \"full_page\": true\n      }\n    }\n  ],\n  \"city\": \"<string>\",\n  \"consent_header\": true,\n  \"cookies\": [\n    {\n      \"creation\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"expires\": \"<string>\",\n      \"extensions\": [\n        \"<string>\"\n      ],\n      \"hostOnly\": true,\n      \"httpOnly\": true,\n      \"lastAccessed\": \"<string>\",\n      \"maxAge\": 123,\n      \"name\": \"<string>\",\n      \"path\": \"<string>\",\n      \"pathIsDefault\": true,\n      \"secure\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"country\": \"US\",\n  \"device\": \"desktop\",\n  \"expected_status_codes\": [\n    0\n  ],\n  \"formats\": [],\n  \"headers\": {},\n  \"http2\": false,\n  \"is_xhr\": false,\n  \"locale\": \"en-US\",\n  \"markdown_backend\": \"full_page\",\n  \"method\": \"GET\",\n  \"network_capture\": [\n    {\n      \"resource_type\": \"document\",\n      \"status_code\": 349.5,\n      \"validation\": false,\n      \"wait_for_requests_count\": 0,\n      \"wait_for_requests_count_timeout\": 123\n    }\n  ],\n  \"parse\": false,\n  \"parser\": {\n    \"myParser\": {\n      \"option1\": \"value1\"\n    }\n  },\n  \"referrer_type\": \"no-referrer\",\n  \"render\": true,\n  \"request_timeout\": 2,\n  \"session\": {\n    \"id\": \"<string>\",\n    \"prefetch_userbrowser\": false,\n    \"renew_on_blocked\": false,\n    \"retry\": false,\n    \"timeout\": 123\n  },\n  \"skill\": \"dynamic-content\",\n  \"tag\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"storage_compress\": true,\n  \"storage_object_name\": \"<string>\",\n  \"storage_type\": \"<string>\",\n  \"storage_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "<string>",
  "task": {
    "_query": "<unknown>",
    "created_at": "<string>",
    "id": "<string>",
    "input": "<unknown>",
    "status_url": "<string>",
    "account_name": "<string>",
    "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
    "download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
    "error": "Connection timeout",
    "error_type": "timeout_error",
    "modified_at": "<string>",
    "output_url": "<string>",
    "queue": "<string>",
    "status_code": 123
  }
}

POST

extract

async

Extract Async

curl --request POST \
  --url https://sdk.nimbleway.com/v2/extract/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "auto_driver_configuration": {},
  "body": "<unknown>",
  "browser": "chrome",
  "browser_actions": [
    {
      "goto": "https://example.com/login"
    },
    {
      "wait_for_element": "#login-form"
    },
    {
      "fill": {
        "selector": "#username",
        "value": "[email protected]"
      }
    },
    {
      "fill": {
        "selector": "#password",
        "value": "password123"
      }
    },
    {
      "click": "#submit"
    },
    {
      "screenshot": {
        "full_page": true
      }
    }
  ],
  "city": "<string>",
  "consent_header": true,
  "cookies": [
    {
      "creation": "<string>",
      "domain": "<string>",
      "expires": "<string>",
      "extensions": [
        "<string>"
      ],
      "hostOnly": true,
      "httpOnly": true,
      "lastAccessed": "<string>",
      "maxAge": 123,
      "name": "<string>",
      "path": "<string>",
      "pathIsDefault": true,
      "secure": true,
      "value": "<string>"
    }
  ],
  "country": "US",
  "device": "desktop",
  "expected_status_codes": [
    0
  ],
  "formats": [],
  "headers": {},
  "http2": false,
  "is_xhr": false,
  "locale": "en-US",
  "markdown_backend": "full_page",
  "method": "GET",
  "network_capture": [
    {
      "resource_type": "document",
      "status_code": 349.5,
      "validation": false,
      "wait_for_requests_count": 0,
      "wait_for_requests_count_timeout": 123
    }
  ],
  "parse": false,
  "parser": {
    "myParser": {
      "option1": "value1"
    }
  },
  "referrer_type": "no-referrer",
  "render": true,
  "request_timeout": 2,
  "session": {
    "id": "<string>",
    "prefetch_userbrowser": false,
    "renew_on_blocked": false,
    "retry": false,
    "timeout": 123
  },
  "skill": "dynamic-content",
  "tag": "<string>",
  "callback_url": "<string>",
  "storage_compress": true,
  "storage_object_name": "<string>",
  "storage_type": "<string>",
  "storage_url": "<string>"
}
'

import requests

url = "https://sdk.nimbleway.com/v2/extract/async"

payload = {
    "url": "<string>",
    "auto_driver_configuration": {},
    "body": "<unknown>",
    "browser": "chrome",
    "browser_actions": [{ "goto": "https://example.com/login" }, { "wait_for_element": "#login-form" }, { "fill": {
                "selector": "#username",
                "value": "[email protected]"
            } }, { "fill": {
                "selector": "#password",
                "value": "password123"
            } }, { "click": "#submit" }, { "screenshot": { "full_page": True } }],
    "city": "<string>",
    "consent_header": True,
    "cookies": [
        {
            "creation": "<string>",
            "domain": "<string>",
            "expires": "<string>",
            "extensions": ["<string>"],
            "hostOnly": True,
            "httpOnly": True,
            "lastAccessed": "<string>",
            "maxAge": 123,
            "name": "<string>",
            "path": "<string>",
            "pathIsDefault": True,
            "secure": True,
            "value": "<string>"
        }
    ],
    "country": "US",
    "device": "desktop",
    "expected_status_codes": [0],
    "formats": [],
    "headers": {},
    "http2": False,
    "is_xhr": False,
    "locale": "en-US",
    "markdown_backend": "full_page",
    "method": "GET",
    "network_capture": [
        {
            "resource_type": "document",
            "status_code": 349.5,
            "validation": False,
            "wait_for_requests_count": 0,
            "wait_for_requests_count_timeout": 123
        }
    ],
    "parse": False,
    "parser": { "myParser": { "option1": "value1" } },
    "referrer_type": "no-referrer",
    "render": True,
    "request_timeout": 2,
    "session": {
        "id": "<string>",
        "prefetch_userbrowser": False,
        "renew_on_blocked": False,
        "retry": False,
        "timeout": 123
    },
    "skill": "dynamic-content",
    "tag": "<string>",
    "callback_url": "<string>",
    "storage_compress": True,
    "storage_object_name": "<string>",
    "storage_type": "<string>",
    "storage_url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    auto_driver_configuration: {},
    body: JSON.stringify('<unknown>'),
    browser: 'chrome',
    browser_actions: [
      {goto: 'https://example.com/login'},
      {wait_for_element: '#login-form'},
      {fill: {selector: '#username', value: '[email protected]'}},
      {fill: {selector: '#password', value: 'password123'}},
      {click: '#submit'},
      {screenshot: {full_page: true}}
    ],
    city: '<string>',
    consent_header: true,
    cookies: [
      {
        creation: '<string>',
        domain: '<string>',
        expires: '<string>',
        extensions: ['<string>'],
        hostOnly: true,
        httpOnly: true,
        lastAccessed: '<string>',
        maxAge: 123,
        name: '<string>',
        path: '<string>',
        pathIsDefault: true,
        secure: true,
        value: '<string>'
      }
    ],
    country: 'US',
    device: 'desktop',
    expected_status_codes: [0],
    formats: [],
    headers: {},
    http2: false,
    is_xhr: false,
    locale: 'en-US',
    markdown_backend: 'full_page',
    method: 'GET',
    network_capture: [
      {
        resource_type: 'document',
        status_code: 349.5,
        validation: false,
        wait_for_requests_count: 0,
        wait_for_requests_count_timeout: 123
      }
    ],
    parse: false,
    parser: {myParser: {option1: 'value1'}},
    referrer_type: 'no-referrer',
    render: true,
    request_timeout: 2,
    session: {
      id: '<string>',
      prefetch_userbrowser: false,
      renew_on_blocked: false,
      retry: false,
      timeout: 123
    },
    skill: 'dynamic-content',
    tag: '<string>',
    callback_url: '<string>',
    storage_compress: true,
    storage_object_name: '<string>',
    storage_type: '<string>',
    storage_url: '<string>'
  })
};

fetch('https://sdk.nimbleway.com/v2/extract/async', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sdk.nimbleway.com/v2/extract/async",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'auto_driver_configuration' => [
        
    ],
    'body' => '<unknown>',
    'browser' => 'chrome',
    'browser_actions' => [
        [
                'goto' => 'https://example.com/login'
        ],
        [
                'wait_for_element' => '#login-form'
        ],
        [
                'fill' => [
                                'selector' => '#username',
                                'value' => '[email protected]'
                ]
        ],
        [
                'fill' => [
                                'selector' => '#password',
                                'value' => 'password123'
                ]
        ],
        [
                'click' => '#submit'
        ],
        [
                'screenshot' => [
                                'full_page' => true
                ]
        ]
    ],
    'city' => '<string>',
    'consent_header' => true,
    'cookies' => [
        [
                'creation' => '<string>',
                'domain' => '<string>',
                'expires' => '<string>',
                'extensions' => [
                                '<string>'
                ],
                'hostOnly' => true,
                'httpOnly' => true,
                'lastAccessed' => '<string>',
                'maxAge' => 123,
                'name' => '<string>',
                'path' => '<string>',
                'pathIsDefault' => true,
                'secure' => true,
                'value' => '<string>'
        ]
    ],
    'country' => 'US',
    'device' => 'desktop',
    'expected_status_codes' => [
        0
    ],
    'formats' => [
        
    ],
    'headers' => [
        
    ],
    'http2' => false,
    'is_xhr' => false,
    'locale' => 'en-US',
    'markdown_backend' => 'full_page',
    'method' => 'GET',
    'network_capture' => [
        [
                'resource_type' => 'document',
                'status_code' => 349.5,
                'validation' => false,
                'wait_for_requests_count' => 0,
                'wait_for_requests_count_timeout' => 123
        ]
    ],
    'parse' => false,
    'parser' => [
        'myParser' => [
                'option1' => 'value1'
        ]
    ],
    'referrer_type' => 'no-referrer',
    'render' => true,
    'request_timeout' => 2,
    'session' => [
        'id' => '<string>',
        'prefetch_userbrowser' => false,
        'renew_on_blocked' => false,
        'retry' => false,
        'timeout' => 123
    ],
    'skill' => 'dynamic-content',
    'tag' => '<string>',
    'callback_url' => '<string>',
    'storage_compress' => true,
    'storage_object_name' => '<string>',
    'storage_type' => '<string>',
    'storage_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sdk.nimbleway.com/v2/extract/async"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"auto_driver_configuration\": {},\n  \"body\": \"<unknown>\",\n  \"browser\": \"chrome\",\n  \"browser_actions\": [\n    {\n      \"goto\": \"https://example.com/login\"\n    },\n    {\n      \"wait_for_element\": \"#login-form\"\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#username\",\n        \"value\": \"[email protected]\"\n      }\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#password\",\n        \"value\": \"password123\"\n      }\n    },\n    {\n      \"click\": \"#submit\"\n    },\n    {\n      \"screenshot\": {\n        \"full_page\": true\n      }\n    }\n  ],\n  \"city\": \"<string>\",\n  \"consent_header\": true,\n  \"cookies\": [\n    {\n      \"creation\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"expires\": \"<string>\",\n      \"extensions\": [\n        \"<string>\"\n      ],\n      \"hostOnly\": true,\n      \"httpOnly\": true,\n      \"lastAccessed\": \"<string>\",\n      \"maxAge\": 123,\n      \"name\": \"<string>\",\n      \"path\": \"<string>\",\n      \"pathIsDefault\": true,\n      \"secure\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"country\": \"US\",\n  \"device\": \"desktop\",\n  \"expected_status_codes\": [\n    0\n  ],\n  \"formats\": [],\n  \"headers\": {},\n  \"http2\": false,\n  \"is_xhr\": false,\n  \"locale\": \"en-US\",\n  \"markdown_backend\": \"full_page\",\n  \"method\": \"GET\",\n  \"network_capture\": [\n    {\n      \"resource_type\": \"document\",\n      \"status_code\": 349.5,\n      \"validation\": false,\n      \"wait_for_requests_count\": 0,\n      \"wait_for_requests_count_timeout\": 123\n    }\n  ],\n  \"parse\": false,\n  \"parser\": {\n    \"myParser\": {\n      \"option1\": \"value1\"\n    }\n  },\n  \"referrer_type\": \"no-referrer\",\n  \"render\": true,\n  \"request_timeout\": 2,\n  \"session\": {\n    \"id\": \"<string>\",\n    \"prefetch_userbrowser\": false,\n    \"renew_on_blocked\": false,\n    \"retry\": false,\n    \"timeout\": 123\n  },\n  \"skill\": \"dynamic-content\",\n  \"tag\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"storage_compress\": true,\n  \"storage_object_name\": \"<string>\",\n  \"storage_type\": \"<string>\",\n  \"storage_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sdk.nimbleway.com/v2/extract/async")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"auto_driver_configuration\": {},\n  \"body\": \"<unknown>\",\n  \"browser\": \"chrome\",\n  \"browser_actions\": [\n    {\n      \"goto\": \"https://example.com/login\"\n    },\n    {\n      \"wait_for_element\": \"#login-form\"\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#username\",\n        \"value\": \"[email protected]\"\n      }\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#password\",\n        \"value\": \"password123\"\n      }\n    },\n    {\n      \"click\": \"#submit\"\n    },\n    {\n      \"screenshot\": {\n        \"full_page\": true\n      }\n    }\n  ],\n  \"city\": \"<string>\",\n  \"consent_header\": true,\n  \"cookies\": [\n    {\n      \"creation\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"expires\": \"<string>\",\n      \"extensions\": [\n        \"<string>\"\n      ],\n      \"hostOnly\": true,\n      \"httpOnly\": true,\n      \"lastAccessed\": \"<string>\",\n      \"maxAge\": 123,\n      \"name\": \"<string>\",\n      \"path\": \"<string>\",\n      \"pathIsDefault\": true,\n      \"secure\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"country\": \"US\",\n  \"device\": \"desktop\",\n  \"expected_status_codes\": [\n    0\n  ],\n  \"formats\": [],\n  \"headers\": {},\n  \"http2\": false,\n  \"is_xhr\": false,\n  \"locale\": \"en-US\",\n  \"markdown_backend\": \"full_page\",\n  \"method\": \"GET\",\n  \"network_capture\": [\n    {\n      \"resource_type\": \"document\",\n      \"status_code\": 349.5,\n      \"validation\": false,\n      \"wait_for_requests_count\": 0,\n      \"wait_for_requests_count_timeout\": 123\n    }\n  ],\n  \"parse\": false,\n  \"parser\": {\n    \"myParser\": {\n      \"option1\": \"value1\"\n    }\n  },\n  \"referrer_type\": \"no-referrer\",\n  \"render\": true,\n  \"request_timeout\": 2,\n  \"session\": {\n    \"id\": \"<string>\",\n    \"prefetch_userbrowser\": false,\n    \"renew_on_blocked\": false,\n    \"retry\": false,\n    \"timeout\": 123\n  },\n  \"skill\": \"dynamic-content\",\n  \"tag\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"storage_compress\": true,\n  \"storage_object_name\": \"<string>\",\n  \"storage_type\": \"<string>\",\n  \"storage_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sdk.nimbleway.com/v2/extract/async")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"auto_driver_configuration\": {},\n  \"body\": \"<unknown>\",\n  \"browser\": \"chrome\",\n  \"browser_actions\": [\n    {\n      \"goto\": \"https://example.com/login\"\n    },\n    {\n      \"wait_for_element\": \"#login-form\"\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#username\",\n        \"value\": \"[email protected]\"\n      }\n    },\n    {\n      \"fill\": {\n        \"selector\": \"#password\",\n        \"value\": \"password123\"\n      }\n    },\n    {\n      \"click\": \"#submit\"\n    },\n    {\n      \"screenshot\": {\n        \"full_page\": true\n      }\n    }\n  ],\n  \"city\": \"<string>\",\n  \"consent_header\": true,\n  \"cookies\": [\n    {\n      \"creation\": \"<string>\",\n      \"domain\": \"<string>\",\n      \"expires\": \"<string>\",\n      \"extensions\": [\n        \"<string>\"\n      ],\n      \"hostOnly\": true,\n      \"httpOnly\": true,\n      \"lastAccessed\": \"<string>\",\n      \"maxAge\": 123,\n      \"name\": \"<string>\",\n      \"path\": \"<string>\",\n      \"pathIsDefault\": true,\n      \"secure\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"country\": \"US\",\n  \"device\": \"desktop\",\n  \"expected_status_codes\": [\n    0\n  ],\n  \"formats\": [],\n  \"headers\": {},\n  \"http2\": false,\n  \"is_xhr\": false,\n  \"locale\": \"en-US\",\n  \"markdown_backend\": \"full_page\",\n  \"method\": \"GET\",\n  \"network_capture\": [\n    {\n      \"resource_type\": \"document\",\n      \"status_code\": 349.5,\n      \"validation\": false,\n      \"wait_for_requests_count\": 0,\n      \"wait_for_requests_count_timeout\": 123\n    }\n  ],\n  \"parse\": false,\n  \"parser\": {\n    \"myParser\": {\n      \"option1\": \"value1\"\n    }\n  },\n  \"referrer_type\": \"no-referrer\",\n  \"render\": true,\n  \"request_timeout\": 2,\n  \"session\": {\n    \"id\": \"<string>\",\n    \"prefetch_userbrowser\": false,\n    \"renew_on_blocked\": false,\n    \"retry\": false,\n    \"timeout\": 123\n  },\n  \"skill\": \"dynamic-content\",\n  \"tag\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"storage_compress\": true,\n  \"storage_object_name\": \"<string>\",\n  \"storage_type\": \"<string>\",\n  \"storage_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "<string>",
  "task": {
    "_query": "<unknown>",
    "created_at": "<string>",
    "id": "<string>",
    "input": "<unknown>",
    "status_url": "<string>",
    "account_name": "<string>",
    "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
    "download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
    "error": "Connection timeout",
    "error_type": "timeout_error",
    "modified_at": "<string>",
    "output_url": "<string>",
    "queue": "<string>",
    "status_code": 123
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

url

string

required

Target URL to scrape

auto_driver_configuration

object

Custom flow for the optimization engine: maps candidate names to the number of attempts to spend on each candidate before advancing (0 skips it). Key order defines the flow order. Providing it opts the request into 'auto' driver selection.

Show child attributes

Example:

{
  "vx10": 2,
  "vx10-pro": 0,
  "vx6-fast": 1,
  "vx6-stealth": 1,
  "vx8": 5,
  "vx8-pro": 5
}

body

any

Request body for POST, PUT, PATCH methods

Example:

{ "key": "value" }

browser

Browser type to emulate

Available options:

chrome,

firefox

Example:

"chrome"

browser_actions

object[]

Array of browser automation actions to execute sequentially

Minimum array length: 1

A browser automation action. Exactly one action key must be present.

Show child attributes

Example:

[
  { "goto": "https://example.com/login" },
  { "wait_for_element": "#login-form" },
  {
    "fill": {
      "selector": "#username",
      "value": "[email protected]"
    }
  },
  {
    "fill": {
      "selector": "#password",
      "value": "password123"
    }
  },
  { "click": "#submit" },
  { "screenshot": { "full_page": true } }
]

city

string

City for geolocation

Example:

"Los Angeles"

Whether to automatically handle cookie consent headers

Browser cookies as array of cookie objects

Show child attributes

country

default:ALL

Country code for geolocation and proxy selection

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

Example:

"US"

device

enum<string>

default:desktop

Device type for browser emulation

Available options:

desktop,

mobile,

tablet

Example:

"desktop"

driver

enum<string>

Browser driver to use

Available options:

auto,

vx6,

vx8,

vx8-pro,

vx10,

vx10-pro,

vx12,

vx12-pro,

media-vx6,

fast-vx6

Example:

"vx8"

expected_status_codes

integer[]

Expected HTTP status codes for successful requests

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

[200, 201]

formats

enum<string>[]

List of acceptable response formats in order of preference

Minimum array length: 1

Available options:

html,

markdown,

screenshot,

headers,

links

Example:

["html"]

headers

object

Custom HTTP headers to include in the request

Show child attributes

Example:

{
  "Accept-Language": "en-US",
  "User-Agent": "CustomBot/1.0"
}

http2

boolean

default:false

Whether to use HTTP/2 protocol

Example:

true

is_xhr

boolean

default:false

Whether to emulate XMLHttpRequest behavior

Example:

true

locale

default:en

Locale for browser language and region settings

Available options:

aa-DJ,

aa-ER,

aa-ET,

af,

af-NA,

af-ZA,

ak,

ak-GH,

am,

am-ET,

an-ES,

ar,

ar-AE,

ar-BH,

ar-DZ,

ar-EG,

ar-IN,

ar-IQ,

ar-JO,

ar-KW,

ar-LB,

ar-LY,

ar-MA,

ar-OM,

ar-QA,

ar-SA,

ar-SD,

ar-SY,

ar-TN,

ar-YE,

as,

as-IN,

asa,

asa-TZ,

ast-ES,

az,

az-AZ,

az-Cyrl,

az-Cyrl-AZ,

az-Latn,

az-Latn-AZ,

be,

be-BY,

bem,

bem-ZM,

ber-DZ,

ber-MA,

bez,

bez-TZ,

bg,

bg-BG,

bho-IN,

bm,

bm-ML,

bn,

bn-BD,

bn-IN,

bo,

bo-CN,

bo-IN,

br-FR,

brx-IN,

bs,

bs-BA,

byn-ER,

ca,

ca-AD,

ca-ES,

ca-FR,

ca-IT,

cgg,

cgg-UG,

chr,

chr-US,

crh-UA,

cs,

cs-CZ,

csb-PL,

cv-RU,

cy,

cy-GB,

da,

da-DK,

dav,

dav-KE,

de,

de-AT,

de-BE,

de-CH,

de-DE,

de-LI,

de-LU,

dv-MV,

dz-BT,

ebu,

ebu-KE,

ee,

ee-GH,

ee-TG,

el,

el-CY,

el-GR,

en,

en-AG,

en-AS,

en-AU,

en-BE,

en-BW,

en-BZ,

en-CA,

en-DK,

en-GB,

en-GU,

en-HK,

en-IE,

en-IN,

en-JM,

en-MH,

en-MP,

en-MT,

en-MU,

en-NA,

en-NG,

en-NZ,

en-PH,

en-PK,

en-SG,

en-TT,

en-UM,

en-US,

en-VI,

en-ZA,

en-ZM,

en-ZW,

eo,

es,

es-419,

es-AR,

es-BO,

es-CL,

es-CO,

es-CR,

es-CU,

es-DO,

es-EC,

es-ES,

es-GQ,

es-GT,

es-HN,

es-MX,

es-NI,

es-PA,

es-PE,

es-PR,

es-PY,

es-SV,

es-US,

es-UY,

es-VE,

et,

et-EE,

eu,

eu-ES,

fa,

fa-AF,

fa-IR,

ff,

ff-SN,

fi,

fi-FI,

fil,

fil-PH,

fo,

fo-FO,

fr,

fr-BE,

fr-BF,

fr-BI,

fr-BJ,

fr-BL,

fr-CA,

fr-CD,

fr-CF,

fr-CG,

fr-CH,

fr-CI,

fr-CM,

fr-DJ,

fr-FR,

fr-GA,

fr-GN,

fr-GP,

fr-GQ,

fr-KM,

fr-LU,

fr-MC,

fr-MF,

fr-MG,

fr-ML,

fr-MQ,

fr-NE,

fr-RE,

fr-RW,

fr-SN,

fr-TD,

fr-TG,

fur-IT,

fy-DE,

fy-NL,

ga,

ga-IE,

gd-GB,

gez-ER,

gez-ET,

gl,

gl-ES,

gsw,

gsw-CH,

gu,

gu-IN,

guz,

guz-KE,

gv,

gv-GB,

ha,

ha-Latn,

ha-Latn-GH,

ha-Latn-NE,

ha-Latn-NG,

ha-NG,

haw,

haw-US,

he,

he-IL,

hi,

hi-IN,

hne-IN,

hr,

hr-HR,

hsb-DE,

ht-HT,

hu,

hu-HU,

hy,

hy-AM,

id,

id-ID,

ig,

ig-NG,

ii,

ii-CN,

ik-CA,

is,

is-IS,

it,

it-CH,

it-IT,

iu-CA,

iw-IL,

ja,

ja-JP,

jmc,

jmc-TZ,

ka,

ka-GE,

kab,

kab-DZ,

kam,

kam-KE,

kde,

kde-TZ,

kea,

kea-CV,

khq,

khq-ML,

ki,

ki-KE,

kk,

kk-Cyrl,

kk-Cyrl-KZ,

kk-KZ,

kl,

kl-GL,

kln,

kln-KE,

km,

km-KH,

kn,

kn-IN,

ko,

ko-KR,

kok,

kok-IN,

ks-IN,

ku-TR,

kw,

kw-GB,

ky-KG,

lag,

lag-TZ,

lb-LU,

lg,

lg-UG,

li-BE,

li-NL,

lij-IT,

lo-LA,

lt,

lt-LT,

luo,

luo-KE,

luy,

luy-KE,

lv,

lv-LV,

mag-IN,

mai-IN,

mas,

mas-KE,

mas-TZ,

mer,

mer-KE,

mfe,

mfe-MU,

mg,

mg-MG,

mhr-RU,

mi-NZ,

mk,

mk-MK,

ml,

ml-IN,

mn-MN,

mr,

mr-IN,

ms,

ms-BN,

ms-MY,

mt,

mt-MT,

my,

my-MM,

nan-TW,

naq,

naq-NA,

nb,

nb-NO,

nd,

nd-ZW,

nds-DE,

nds-NL,

ne,

ne-IN,

ne-NP,

nl,

nl-AW,

nl-BE,

nl-NL,

nn,

nn-NO,

nr-ZA,

nso-ZA,

nyn,

nyn-UG,

oc-FR,

om,

om-ET,

om-KE,

or,

or-IN,

os-RU,

pa,

pa-Arab,

pa-Arab-PK,

pa-Guru,

pa-Guru-IN,

pa-IN,

pa-PK,

pap-AN,

pl,

pl-PL,

ps,

ps-AF,

pt,

pt-BR,

pt-GW,

pt-MZ,

pt-PT,

rm,

rm-CH,

ro,

ro-MD,

ro-RO,

rof,

rof-TZ,

ru,

ru-MD,

ru-RU,

ru-UA,

rw,

rw-RW,

rwk,

rwk-TZ,

sa-IN,

saq,

saq-KE,

sc-IT,

sd-IN,

se-NO,

seh,

seh-MZ,

ses,

ses-ML,

sg,

sg-CF,

shi,

shi-Latn,

shi-Latn-MA,

shi-Tfng,

shi-Tfng-MA,

shs-CA,

si,

si-LK,

sid-ET,

sk,

sk-SK,

sl,

sl-SI,

sn,

sn-ZW,

so,

so-DJ,

so-ET,

so-KE,

so-SO,

sq,

sq-AL,

sq-MK,

sr,

sr-Cyrl,

sr-Cyrl-BA,

sr-Cyrl-ME,

sr-Cyrl-RS,

sr-Latn,

sr-Latn-BA,

sr-Latn-ME,

sr-Latn-RS,

sr-ME,

sr-RS,

ss-ZA,

st-ZA,

sv,

sv-FI,

sv-SE,

sw,

sw-KE,

sw-TZ,

ta,

ta-IN,

ta-LK,

te,

te-IN,

teo,

teo-KE,

teo-UG,

tg-TJ,

th,

th-TH,

ti,

ti-ER,

ti-ET,

tig-ER,

tk-TM,

tl-PH,

tn-ZA,

to,

to-TO,

tr,

tr-CY,

tr-TR,

ts-ZA,

tt-RU,

tzm,

tzm-Latn,

tzm-Latn-MA,

ug-CN,

uk,

uk-UA,

unm-US,

ur,

ur-IN,

ur-PK,

uz,

uz-Arab,

uz-Arab-AF,

uz-Cyrl,

uz-Cyrl-UZ,

uz-Latn,

uz-Latn-UZ,

uz-UZ,

ve-ZA,

vi,

vi-VN,

vun,

vun-TZ,

wa-BE,

wae-CH,

wal-ET,

wo-SN,

xh-ZA,

xog,

xog-UG,

yi-US,

yo,

yo-NG,

yue-HK,

zh,

zh-CN,

zh-HK,

zh-Hans,

zh-Hans-CN,

zh-Hans-HK,

zh-Hans-MO,

zh-Hans-SG,

zh-Hant,

zh-Hant-HK,

zh-Hant-MO,

zh-Hant-TW,

zh-SG,

zh-TW,

zu,

zu-ZA

Example:

"en-US"

markdown_backend

enum<string>

default:full_page

Selects which markdown conversion strategy to use. "full_page" converts the entire HTML page. "main_content" uses Mozilla Readability to extract the main article content before converting.

Available options:

full_page,

main_content

Example:

"full_page"

method

enum<string>

default:GET

HTTP method for the request

Available options:

GET,

POST,

PUT,

PATCH,

DELETE

Example:

"GET"

network_capture

object[]

Filters for capturing network traffic

Show child attributes

enum<string>

Operating system to emulate

Available options:

windows,

mac os,

linux,

android,

ios

Example:

"windows"

parse

boolean

default:false

Whether to parse the response content

Example:

true

parser

Custom parser configuration as a key-value map

Show child attributes

Example:

{ "myParser": { "option1": "value1" } }

referrer_type

Referrer policy for the request

Available options:

random,

no-referer,

same-origin

Example:

"no-referrer"

render

Whether to render JavaScript content using a browser

Example:

true

request_timeout

number

Request timeout in milliseconds

Required range: x >= 1

Example:

30000

session

object

Show child attributes

skill

Skills or capabilities required for the request

Example:

"dynamic-content"

state

enum<string>

US state for geolocation (only valid when country is US)

Available options:

AL,

AK,

AS,

AZ,

AR,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

GU,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

MP,

OH,

OK,

OR,

PA,

PR,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

VI,

WA,

WV,

WI,

WY

Example:

"CA"

tag

string

User-defined tag for request identification

Example:

"campaign-2024-q1"

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

Task created successfully

Response when an async extract task is created successfully.

status

string

required

Status indicating the async task was created successfully.

Allowed value: "success"

task

object

required

The created async task details.

Show child attributes

⌘I

Search API

Agents API

Extract API

Extract Templates API

Map API

Crawl API

SERP API

Media API

Domain Knowledge API

Jobs API

Tasks & Batches API

Extract Async

Authorizations

Body

Response