---
title: "Read a page as markdown"
method: POST
path: "/v1/web/scrape"
tags: ["Web"]
---

# Read a page as markdown

`POST /v1/web/scrape`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/web/scrape`
- Auth: HTTP bearer

Any public page rendered and turned into clean markdown (main content only by default), with its title and description — and the page's links if you ask. Use it to quote sources, read documentation, pull facts for a script. Pages behind a login cannot be read. When the provider cannot read a page (or is out) the page is fetched and read by us instead, at no provider cost; `via` says which.

**Billing:** 1 provider credit per page · **Rate limit:** 60/min

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Request body

- object
  - `url` string, uri, required: The page to read
  - `links` boolean: Also return the links on the page
  - `max_age_seconds` integer: A copy fetched within this many seconds is fine (faster, cheaper); 0 = always fresh
  - `only_main_content` boolean: Drop menus, footers and ads

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)