Scrape a web page

Fetch a URL and convert it to Markdown using webfold. The response is returned as plain text Markdown, not JSON.

POST/v1/web/scrape

Authorization

AuthorizationBearer token (JWT) · headerrequired

Bearer API key issued for your account. Send Authorization: Bearer <key>.

Request body

requiredapplication/json

urlstring<uri>required

Responses

200

Markdown content

string

400

Bad request

string

401

Missing or invalid bearer token

string

403

Billing or plan entitlement blocked the request

string

502

Upstream service (arXiv, YouTube, web page) failed

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

urlstring*

Request

curl -X POST 'https://api.webfold.ai/v1/web/scrape' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com"
}'

import requests

response = requests.post(
    "https://api.webfold.ai/v1/web/scrape",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"url\": \"https://example.com\"\n}",
)

const response = await fetch("https://api.webfold.ai/v1/web/scrape", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"url\": \"https://example.com\"\n}"
});

Response

"string"

"string"

"string"

"string"

"string"