Client area

GET · Meta & discovery

Fetch a public web page

Fetch a public web page

GET /api/v1/web/fetch
R Read
Scope read:account

This scope is inferred from the method and the endpoint's group — the OpenAPI document does not carry one per operation. The wire is authoritative; whoami reports what your token actually holds.

Description

Returns url, finalUrl, status, contentType, title, description, language, canonical, headings[] (h1–h3), text (readable body, prefixed with a data banner), links[], images[] and truncated; format=html adds the raw html (≤ 60 000 chars).

Query parameters

Name Type Description
url required string · uri Up to 2048 characters.
format enum One of text, html.

Responses

A 200 response returns the shape shown in the rail. Every non-2xx response is an RFC 7807 problem with a stable code.

Commonly returned errors

The codes this operation reaches on its own path: the auth stack, its own validation and ownership checks, and the transport. Not a closed set — a shared code from the full registry can still surface. Each links to the code’s own page, the same URL its type dereferences to.

401 No token was presented, or the token is revoked, expired or unknown.
403 The token lacks a required scope, or this account does not own the resource.
422 Validation error
429 The rate limit for this token is exhausted. See `Retry-After`.
500 Something went wrong on our side. The failure is logged against `requestId`.
Esc
navigate open Esc close