Image Generation
Image Analysis
Model Training
Content Moderation
Authentication
Server Status
Web Extraction API
Web Extraction API
Extracts organized texts, images, tables and other content from a web page.
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Web page extraction request
The body is of type object
.
Response
200
application/json
Web page extracted successfully
The response is of type object
.
Was this page helpful?
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
}
}
}