AI Services

Extract text from a web page using AI.

Changed on Oct 20, 2023

This endpoint is used to extract text from a web page using AI. It can take into account all the features such as metadata, inline code, codeblocks, image & html references and other links as well.

post/api/ai/v2/web-extract

Request

Base URL
https://api.worqhat.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/docs/api/ai/v2/web-extract/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

url_pathstring

The URL of the web page to be extracted.

headlineboolean

Whether to extract the headline of the web page.

inline_codeboolean

Whether to extract the inline code of the web page.

code_blocksboolean

Whether to extract the codeblocks of the web page.

referencesboolean

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

tablesboolean

Whether to extract the tables in the web page.

Example request

{
  "url_path": "https://www.worqhat.com",
  "headline": true,
  "inline_code": true,
  "code_blocks": true,
  "references": true,
  "tables": true
}

Response

Successful response

statusstring

Status indicating the success of the Audio Conversion Process.

processing_timeinteger

The time taken to process the request, in milliseconds.

processing_idstring

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

processing_countinteger

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.

Example response

{
  "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
}

Changes

Oct 20, 2023871850b7231f Revision changes
- breaking
  request body became required
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  api operation id webPageExtraction removed and replaced with extractTextFromWebPageV2
- info
  the endpoint scheme security bearerAuth was added to the API
- info
  api tag AI Services added
- info
  api tag AI removed
- info
  the request property became optional
- info
  the request property default value true was added
- info
  the request property default value true was added
- info
  the request property default value true was added
- info
  the request property default value true was added
- info
  the request property default value true was added
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Aug 15, 2023b5ffe2a9748f Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  api operation id webPageExtraction was added
- info
  api tag AI added
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (5 revisions)