POST
/
api
/
ai
/
v2
/
web-extract
curl --request POST \
  --url https://api.worqhat.com/api/ai/v2/web-extract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com",
  "includeHTML": false,
  "onlyMainContent": true
}'
{
  "data": {
    "content": "<string>",
    "markdown": "<string>",
    "linksOnPage": [
      "<string>"
    ],
    "metadata": {
      "title": "<string>",
      "description": "<string>",
      "keywords": "<string>",
      "robots": "<string>",
      "ogTitle": "<string>",
      "ogDescription": "<string>",
      "ogImage": "<string>",
      "ogLocale": "<string>",
      "ogLocaleAlternate": [
        "<string>"
      ],
      "ogSiteName": "<string>",
      "screenshot": "<string>",
      "sourceURL": "<string>",
      "pageStatusCode": 123,
      "processingTime": 123,
      "processingId": "<string>",
      "processingCount": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
Web page extraction request
​
url
string
required

The URL of the web page to extract content from.

​
includeHTML
boolean
default:false

Include the HTML version of the content in the response.

​
onlyMainContent
boolean
default:true

Return only the main content, excluding headers, footers, etc.

Response

200
application/json
Web page extracted successfully
​
data
object
required

Was this page helpful?