v14

latestOpenAPI 3.0.3raw.githubusercontent.com2023-06-27173980.4 KB

Extract content from a web page.

post/api/ai/v2/web-extract

Request body

url_pathstring required

The URL of the web page to extract content from.

headlineboolean

Flag indicating whether to extract headlines from the web page. (Optional)

inline_codeboolean

Flag indicating whether to extract inline code snippets from the web page. (Optional)

code_blocksboolean

Flag indicating whether to extract code blocks from the web page. (Optional)

referencesboolean

Flag indicating whether to extract references from the web page. (Optional)

tablesboolean

Flag indicating whether to extract tables from the web page. (Optional)

Response

idstring

The unique identifier associated with the extraction process.

statusstring

The status of the extraction process.

timestampinteger

The timestamp when the extraction request was processed.

processing_countinteger

The number of times the content has been processed to generate the final result.

Example response

{
  "id": "77d4d87d-6e7e-4556-a4c2-aab535cfb5b4",
  "status": "success",
  "timestamp": 1683173445143,
  "content": {
    "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_count": 2152
}