Read an oEmbed response

Get an embeddable card or link preview for a supported Veil URL.

GET/oembed

Access: Public; API key optional
Client: Browser fetch supported

Parameters#

Name	Location	Meaning
`url`Required	Query	A Veil person, organisation or /v/ verification URL.
`format`	Query	json. XML is not supported.
`maxwidth`	Query	Optional maximum width. Below 280 produces a link response.
`maxheight`	Query	Optional maximum height. Below 200 produces a link response.

Request examples#

cURL

curl -fsS 'https://veil.rip/oembed?url=https%3A%2F%2Fveil.rip%2Fo%2Fveil&format=json'

javascript

const response = await fetch("https://veil.rip/oembed?url=https%3A%2F%2Fveil.rip%2Fo%2Fveil&format=json");
const result = await response.json();

Try the request#

Response#

HTTP 200application/json

A card can return type rich with widget HTML, dimensions and thumbnail metadata. Small size limits or verification links return type link.

Field	Type	Meaning
`version`	`string`	oEmbed protocol version 1.0.
`type`	`string`	rich for a card widget; link for verification links or restrictive dimensions.
`provider_name`	`string`	Veil.
`provider_url`	`string`	Directory base URL.
`cache_age`	`integer`	Suggested cache lifetime in seconds.
`title`	`string`	Readable title.
`author_name`	`string, optional`	Display name when known.
`author_url`	`string, optional`	Permanent author card URL.
`html`	`string, optional`	Iframe HTML for type=rich.
`width`	`integer, optional`	Widget width for type=rich.
`height`	`integer, optional`	Widget height for type=rich.
`thumbnail_url`	`string, optional`	Server-rendered card image.
`thumbnail_width`	`integer, optional`	Thumbnail width in pixels.
`thumbnail_height`	`integer, optional`	Thumbnail height in pixels.

Response headers#

Header	Value	Meaning
`Content-Type`	`application/json`	Use the declared media type before choosing a parser.
`Date`	`HTTP date`	Server time. Compare it with your clock when signing requests.
`Cache-Control`	`public, max-age=300`	Server-rendered previews may be cached for five minutes.
`Retry-After`	`integer seconds, on rate_limited or busy`	Wait at least this long before retrying. Other 429/503 codes do not necessarily include it.

Errors#

API errors return an error object. Use error.code for program logic; error.message is English text for people and can change. Response and error guide

HTTP Code Meaning and next step

400

HTTP	Code	Meaning and next step
400	`invalid_parameter`	A path, query or body field is missing, malformed or outside its accepted range. Correct the field named in `error.message` before sending again.
404	`not_found`	The requested card, key, alias, code or resource was not found. Check the identifier. Temporary codes and previews may already have expired or been used.
501	`format_not_implemented`	Only JSON oEmbed responses are supported. Request format=json.

invalid_parameter

A path, query or body field is missing, malformed or outside its accepted range.

Correct the field named in error.message before sending again.

404

not_found

The requested card, key, alias, code or resource was not found.

Check the identifier. Temporary codes and previews may already have expired or been used.

501

format_not_implemented

Only JSON oEmbed responses are supported.

Request format=json.

When using an optional API key

HTTP	Code	Meaning and next step
401	`invalid_api_key`	The bearer credential is malformed, unknown, expired or revoked. Use an active key. To use anonymous public access, remove `Authorization` entirely. Invalid credentials never fall back automatically.
403	`api_key_scope`	The API key lacks read or verify scope, or the endpoint does not accept bearer keys. Use the correct scope. Identity writes and key management still require a device signature.
403	`api_key_suspended`	This API key is suspended. Ask staff to restore it; another key cannot lift an account suspension.
403	`developer_suspended`	The owner’s API account is suspended or the owner card is unavailable. Check the owner account and any staff restriction. Creating another key does not bypass suspension.

Shared request errors

HTTP Code Meaning and next step

429

HTTP	Code	Meaning and next step
429	`rate_limited`	An anonymous, signed-request or API-key allowance was exceeded. Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.
500	`internal_error`	An unexpected server error occurred. Internal details are not returned. Retry reads with bounded backoff. Check write results before sending a new signed operation.
503	`busy`	The application has reached a temporary concurrency or database limit. Wait `Retry-After` seconds and retry with bounded backoff.

rate_limited

An anonymous, signed-request or API-key allowance was exceeded.

Wait at least Retry-After seconds. Share a queue and retry budget across your workers.

500

internal_error

An unexpected server error occurred. Internal details are not returned.

Retry reads with bounded backoff. Check write results before sending a new signed operation.

503

busy

The application has reached a temporary concurrency or database limit.

Wait Retry-After seconds and retry with bounded backoff.

Read this entry as JSON