Quick actions

Crawl a site

POST

/v1/crawl

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Request Body

application/json

body

url*string

Formaturi

scope?|array<>

Default"host"

include?array<>

Itemsitems <= 50

exclude?array<>

Itemsitems <= 50

maxPages?integer

Range1 <= value <= 100

Default25

maxDepth?integer

Range0 <= value <= 5

Default2

delayMs?integer

Range0 <= value <= 10000

Default500

respectRobots?boolean

Defaulttrue

sitemap?boolean

Defaultfalse

content?array<>

Items1 <= items <= 4

waitUntil?string

Default"load"

Value in"domcontentloaded""load""networkidle"

timeoutMs?integer

Range1000 <= value <= 120000

Default30000

maxMs?integer

Range1000 <= value <= 600000

Default300000

cursor?string

Lengthlength <= 4000000

engine?string

Value in"chromium""firefox""webkit"

device?string

Value in"desktop""mobile"

viewport?

block?

allowHosts?array<>

Itemsitems <= 100

proxyUrl?string

Formaturi

Response Body

application/json

response

start*string

pages*array<>

skipped*array<>

skippedTotal*integer

Range-9007199254740991 <= value <= 9007199254740991

stoppedBy*string

Value in"complete""maxPages""timeout"

pending*integer

Range-9007199254740991 <= value <= 9007199254740991

cursor?string

robots*

ms*number

Example Request

curl -X POST 'https://api.us.webagent.lookover.ai/v1/crawl' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "http://example.com"
}'

Example Request

curl -X POST 'https://api.us.webagent.lookover.ai/v1/crawl' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com"}'

Example ResponseSchema

{
  "start": "string",
  "pages": [
    {
      "url": "string",
      "finalUrl": "string",
      "depth": -9007199254740991,
      "from": "string",
      "status": -9007199254740991,
      "title": "string",
      "linksFound": -9007199254740991,
      "ms": 0,
      "error": "string",
      "loginForm": true,
      "content": {
        "html": "string",
        "cleaned_html": "string",
        "markdown": "string",
        "readability": {
          "title": "string",
          "byline": "string",
          "content": "string",
          "textContent": "string",
          "length": 0
        }
      }
    }
  ],
  "skipped": [
    {
      "url": "string",
      "reason": "ok"
    }
  ],
  "skippedTotal": -9007199254740991,
  "stoppedBy": "complete",
  "pending": -9007199254740991,
  "cursor": "string",
  "robots": {
    "checked": true,
    "available": true,
    "crawlDelayMs": 0
  },
  "ms": 0
}

{  "start": "string",  "pages": [    {      "url": "string",      "finalUrl": "string",      "depth": -9007199254740991,      "from": "string",      "status": -9007199254740991,      "title": "string",      "linksFound": -9007199254740991,      "ms": 0,      "error": "string",      "loginForm": true,      "content": {        "html": "string",        "cleaned_html": "string",        "markdown": "string",        "readability": {          "title": "string",          "byline": "string",          "content": "string",          "textContent": "string",          "length": 0        }      }    }  ],  "skipped": [    {      "url": "string",      "reason": "ok"    }  ],  "skippedTotal": -9007199254740991,  "stoppedBy": "complete",  "pending": -9007199254740991,  "cursor": "string",  "robots": {    "checked": true,    "available": true,    "crawlDelayMs": 0  },  "ms": 0}

Print one page to PDF

POST

/v1/pdf

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Request Body

application/json

body

url*string

Formaturi

waitUntil?string

Default"load"

Value in"domcontentloaded""load""networkidle"

waitForText?string

Lengthlength <= 500

timeoutMs?integer

Range1000 <= value <= 120000

Default30000

paper?string

Default"A4"

Value in"A4""Letter""Legal"

landscape?boolean

Defaultfalse

printBackground?boolean

Defaulttrue

engine?string

Value in"chromium""firefox""webkit"

device?string

Value in"desktop""mobile"

viewport?

block?

allowHosts?array<>

Itemsitems <= 100

proxyUrl?string

Formaturi

Response Body

The bytes

response?fileapplication/pdf

Formatbinary

Example Request

curl -X POST 'https://api.us.webagent.lookover.ai/v1/pdf' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "http://example.com"
}'

Example Request

curl -X POST 'https://api.us.webagent.lookover.ai/v1/pdf' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com"}'

Example ResponseSchema

"string"

"string"

Scrape one page

POST

/v1/scrape

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Request Body

application/json

body

url*string

Formaturi

waitUntil?string

Default"load"

Value in"domcontentloaded""load""networkidle"

waitForText?string

Lengthlength <= 500

timeoutMs?integer

Range1000 <= value <= 120000

Default30000

format?array<>

Items1 <= items

Default

[
  "markdown"
]

[  "markdown"]

screenshot?boolean

pdf?boolean

mhtml?boolean

inventory?boolean

engine?string

Value in"chromium""firefox""webkit"

device?string

Value in"desktop""mobile"

viewport?

block?

allowHosts?array<>

Itemsitems <= 100

proxyUrl?string

Formaturi

Response Body

application/json

response

url*string

content*

metadata*

links*array<>

media?

thirdParty?array<>

screenshot?string

pdf?string

mhtml?string

Example Request

curl -X POST 'https://api.us.webagent.lookover.ai/v1/scrape' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "http://example.com"
}'

Example Request

curl -X POST 'https://api.us.webagent.lookover.ai/v1/scrape' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com"}'

Example ResponseSchema

{
  "url": "string",
  "content": {
    "html": "string",
    "cleaned_html": "string",
    "markdown": "string",
    "readability": {
      "title": "string",
      "byline": "string",
      "content": "string",
      "textContent": "string",
      "length": 0
    }
  },
  "metadata": {
    "title": "string",
    "statusCode": -9007199254740991,
    "description": "string",
    "keywords": "string",
    "author": "string",
    "language": "string",
    "canonical": "string",
    "favicon": "string",
    "ogTitle": "string",
    "ogDescription": "string",
    "ogImage": "string",
    "ogUrl": "string",
    "ogSiteName": "string",
    "publishedTime": "string",
    "modifiedTime": "string",
    "jsonLd": [
      null
    ],
    "wordCount": -9007199254740991,
    "hiddenContent": {
      "invisibleChars": -9007199254740991,
      "hiddenElements": -9007199254740991
    }
  },
  "links": [
    {
      "url": "string",
      "text": "string",
      "internal": true,
      "nofollow": true
    }
  ],
  "media": {
    "images": [
      {
        "url": "string",
        "alt": "string"
      }
    ],
    "videos": [
      "string"
    ],
    "audios": [
      "string"
    ],
    "scripts": [
      "string"
    ],
    "stylesheets": [
      "string"
    ]
  },
  "thirdParty": [
    {
      "host": "string",
      "requests": -9007199254740991,
      "types": [
        "string"
      ]
    }
  ],
  "screenshot": "string",
  "pdf": "string",
  "mhtml": "string"
}

{  "url": "string",  "content": {    "html": "string",    "cleaned_html": "string",    "markdown": "string",    "readability": {      "title": "string",      "byline": "string",      "content": "string",      "textContent": "string",      "length": 0    }  },  "metadata": {    "title": "string",    "statusCode": -9007199254740991,    "description": "string",    "keywords": "string",    "author": "string",    "language": "string",    "canonical": "string",    "favicon": "string",    "ogTitle": "string",    "ogDescription": "string",    "ogImage": "string",    "ogUrl": "string",    "ogSiteName": "string",    "publishedTime": "string",    "modifiedTime": "string",    "jsonLd": [      null    ],    "wordCount": -9007199254740991,    "hiddenContent": {      "invisibleChars": -9007199254740991,      "hiddenElements": -9007199254740991    }  },  "links": [    {      "url": "string",      "text": "string",      "internal": true,      "nofollow": true    }  ],  "media": {    "images": [      {        "url": "string",        "alt": "string"      }    ],    "videos": [      "string"    ],    "audios": [      "string"    ],    "scripts": [      "string"    ],    "stylesheets": [      "string"    ]  },  "thirdParty": [    {      "host": "string",      "requests": -9007199254740991,      "types": [        "string"      ]    }  ],  "screenshot": "string",  "pdf": "string",  "mhtml": "string"}

Screenshot one page

POST

/v1/screenshot

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Request Body

application/json

body

url*string

Formaturi

waitUntil?string

Default"load"

Value in"domcontentloaded""load""networkidle"

waitForText?string

Lengthlength <= 500

timeoutMs?integer

Range1000 <= value <= 120000

Default30000

fullPage?boolean

Defaulttrue

format?string

Default"png"

Value in"png""jpeg""webp"

quality?integer

Range0 <= value <= 100

engine?string

Value in"chromium""firefox""webkit"

device?string

Value in"desktop""mobile"

viewport?

block?

allowHosts?array<>

Itemsitems <= 100

proxyUrl?string

Formaturi

Response Body

The bytes

response?file

Formatbinary

Example Request

curl -X POST 'https://api.us.webagent.lookover.ai/v1/screenshot' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "http://example.com"
}'

Example Request

curl -X POST 'https://api.us.webagent.lookover.ai/v1/screenshot' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com"}'

Example ResponseSchema

"string"

"string"

Crawl a siteCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Print one page to PDFCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Scrape one pageCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Screenshot one pageCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Crawl a site

Authorization

Request Body

Response Body

Print one page to PDF

Authorization

Request Body

Response Body

Scrape one page

Authorization

Request Body

Response Body

Screenshot one page

Authorization

Request Body

Response Body