A page's metadata

1 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/meta

post/meta

Request

Idempotency-Keystring

Makes a retry safe: the same key returns the first request's token and result instead of running again. https://urlpipe.dev/docs/retries

urlstring uri required

The page to fetch: a public http(s) URL.

syncboolean

Return the result in the response instead of a token.

report_tostring uri

Webhook URL the result is POSTed to (async requests).

labelsobject

Your own ids for this request, returned with the result and the webhook.

residentialboolean

Fetch from a home broadband address. +25 credits per page visit.

With sync: true, the result. Without it, the request was accepted: a token to collect the result with.

final_urlstring nullable required

The address the page ended on, after its redirects.

canonical_urlstring nullable required

The page's canonical URL, absolute.

titlestring nullable required

The page's own title, without the site's name around it.

descriptionstring nullable required

site_namestring nullable required

The kind of page, as the page declares it.

languagestring nullable required

ISO 639-1 code of the language the content is written in.

localestring nullable required

The most specific language tag the page declares for that language, BCP 47 (en-US).

published_atstring nullable required

ISO 8601: a date (2024-05-01) or a moment with its offset.

modified_atstring nullable required

ISO 8601, as published_at.

favicon_urlstring nullable required

logo_urlstring nullable required

keywordsstring[] required

theme_colorstring nullable required

generatorstring nullable required

manifest_urlstring nullable required

oembed_urlstring nullable required

structured_data_typesstring[] required

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