Skip to main content
POST
web.page.metadata

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string
required

URL to extract metadata from.

Response

The result

title
string
required

Title.

description
string

Description.

url
string

Url link.

ogDescription
string

Og description.

ogTitle
string

Og title.

twitterDescription
string

Twitter description.

twitterTitle
string

Twitter title.

language
string

Language.

ogType
string

Og type.

twitterCard
string

Twitter card.