---
title: "Extract text from a web page using AI."
method: POST
path: "/api/ai/v2/web-extract"
tags: ["AI Services"]
---

# Extract text from a web page using AI.

`POST /api/ai/v2/web-extract`

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.

## Request body

- object
  - `url_path` string — The URL of the web page to be extracted.
  - `headline` boolean — Whether to extract the headline of the web page.
  - `inline_code` boolean — Whether to extract the inline code of the web page.
  - `code_blocks` boolean — Whether to extract the codeblocks of the web page.
  - `references` boolean — Whether to extract the references of images and other external links in the web page.
  - `tables` boolean — Whether to extract the tables in the web page.

## Response `200`

Successful response

- object
  - `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
    - `text_content` string — The extracted text content from the web page.
    - `tags` object[] — The extracted tags from the web page.
      - `name` string — The name of the tag.
      - `value` string — The value associated with the tag.
      - `data` object — Additional data associated with the tag.

## Other responses

- `400` — Bad Request. This mostly happens because of invalid image sizes. Neither `height` nor `width` of the image should be less than 128px. Only one of the sides of the image should be greater than or equal to 512px. (Eg: 512x512, 512x768, 768x512) Maximum dimensions supported is 512x896.
- `401` — Unauthorized
- `404` — Not Found
- `406` — Not Acceptable
- `500` — Internal Server Error

---

[API](https://skmtc.net/worqhat/apis/worqhat-ai-api-endpoints-2.md) · [All operations](https://skmtc.net/worqhat/apis/worqhat-ai-api-endpoints-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/worqhat/worqhat-ai-api-endpoints-2/versions/fc369f69a3e6/schema)
