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_path": "https://www.worqhat.com",
  "headline": true,
  "inline_code": true,
  "code_blocks": true,
  "references": true,
  "tables": true
}'
{
  "status": "success",
  "data": {
    "text_content": "WorqHat\n\nšŸŽ‰ Our Conversational Language Model WorqBot is now live for Beta use! Try out Now.šŸ¤–\n\nResources\n\nAPIs\n\nConnect your app to WorqHat\n\nDocumentations\n\nLearn how to use our products\n\nChangelogs\n\nCheck what's new\n\nCareers\n\nFind your dream role\n\nCommunity\n\nConnect with other developers, designers, and entrepreneurs\n\nSecurity\n\nOur Security Principles and Practices\n\nBlog\n\nInterviews, tutorials, Updates and more\n\nStatus\n\nOutage updates and announcements\n\nGreen Initiatives\n\nPartnerships to make the World Greener\n\nContact Us\n\n\n\nEnterprise WorqHat Playground\n\nJoin Waitlist\n\nCareers\n- Documentation\n- Changelog\n- Blogs\n- Security\n\nSubscribe to our newsletter\n\nStay up to date with the latest news and updates from WorqHat.\n\n\nJoin us!\n- LinkedIn >\n- Instagram\n- Facebook\n- Twitter\n- GitHub\n\nĀ© 2023. Winlysis Pvt. Ltd., India All rights reserved.\n\n- Terms & Conditions\n- Privacy Policy\n- Statu\n",
    "tags": [
      {
        "name": "language",
        "value": "en",
        "data": {}
      },
      {
        "name": "thumbnail",
        "value": "/resources/WorqHat TM Logo.png",
        "data": {}
      },
      {
        "name": "current_date",
        "value": "2023-01-01",
        "data": {}
      },
      {
        "name": "title",
        "span": [
          "0",
          "7"
        ],
        "span_text": "WorqHat",
        "value": "WorqHat",
        "data": {}
      },
      {
        "name": "link",
        "span": [
          "45",
          "52"
        ],
        "span_text": "WorqBot",
        "value": "//playground.worqhat.app/worqbot",
        "data": {}
      },
      {
        "name": "image",
        "span": [
          "94",
          "94"
        ],
        "value": "/resources/WorqHat TM Logo.png",
        "data": {
          "alt": "WorqHat Logo"
        }
      },
      {
        "name": "control",
        "span": [
          "94",
          "105"
        ],
        "span_text": " Resources ",
        "value": " Resources ",
        "data": {}
      },
      {
        "name": "subheading",
        "span": [
          "12016",
          "12042"
        ],
        "span_text": "Future-proof your business",
        "value": "Future-proof your business",
        "data": {}
      },
      {
        "name": "link",
        "span": [
          "12224",
          "12238"
        ],
        "span_text": "Join Waitlist ",
        "value": "https://join.worqhat.com/waitlist",
        "data": {}
      },
      {
        "name": "image",
        "span": [
          "12295",
          "12295"
        ],
        "value": "/resources/integrations/logo-dropbox-40.svg",
        "data": {
          "alt": "Dropbox Icon"
        }
      }
    ]
  },
  "processing_time": 888,
  "processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
  "processing_count": 12
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
url_path
string

The URL of the web page to be extracted.

headline
boolean
default: true

Whether to extract the headline of the web page.

inline_code
boolean
default: true

Whether to extract the inline code of the web page.

code_blocks
boolean
default: true

Whether to extract the codeblocks of the web page.

references
boolean
default: true

Whether to extract the references of images and other external links in the web page.

tables
boolean
default: true

Whether to extract the tables in the web page.

Response

200 - application/json
status
string

Status indicating the success of the Audio Conversion Process.

processing_time
integer

The time taken to process the request, in milliseconds.

processing_id
string

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_count
integer

The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

data
object