Web

Read a public web page

Fetch a public page through the proxy and return its readable text, title, description, images and ld+json. Pages that render with JavaScript are rendered when the budget allows (render: auto). Private and internal addresses answer 400 SSRF_BLOCKED. 1 credit on a miss, 0 on a hit (24 h).

post/web/read

Request

  • Base URL: https://api.socially.run/v1
  • URL: https://api.socially.run/v1/web/read
  • Auth: HTTP bearer

Request body

urlstring required

An http(s) URL.

maxCharsinteger

Cap on the readable text. Default 8,000.

render'auto' | 'never' | 'always'

always renders every time and never falls back to a plain fetch. It spends render budget and fails closed at RENDER_BUDGET_EXHAUSTED; a deployment with no renderer answers SIDECAR_UNAVAILABLE.

refreshboolean

Bypass the cache and the snapshot; costs a credit even when fresh.

Response

Read a public web page

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.