{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"oembed","kind":"endpoint","group":"share","title":"Read an oEmbed response","method":"GET","path":"/oembed","paths":[],"summary":"Get an embeddable card or link preview for a supported Veil URL.","response":"A card can return type rich with widget HTML, dimensions and thumbnail metadata. Small size limits or verification links return type link.","parameters":[{"name":"url","description":"A Veil person, organisation or /v/ verification URL.","in":"query","required":true},{"name":"format","description":"json. XML is not supported.","in":"query","required":false},{"name":"maxwidth","description":"Optional maximum width. Below 280 produces a link response.","in":"query","required":false},{"name":"maxheight","description":"Optional maximum height. Below 200 produces a link response.","in":"query","required":false}],"sample":"/oembed?url=https%3A%2F%2Fveil.rip%2Fo%2Fveil&format=json","access":"public","base":"directory","notes":[],"errors":["400 invalid_parameter","401 invalid_api_key","403 api_key_scope","403 api_key_suspended","403 developer_suspended","404 not_found","429 rate_limited","500 internal_error","501 format_not_implemented","503 busy"],"related":[],"sections":[{"kind":"code","language":"shell","code":"curl -fsS 'https://veil.rip/oembed?url=https%3A%2F%2Fveil.rip%2Fo%2Fveil&format=json'"},{"kind":"code","language":"javascript","code":"const response = await fetch(\"https://veil.rip/oembed?url=https%3A%2F%2Fveil.rip%2Fo%2Fveil&format=json\");\nconst result = await response.json();"}],"live":true,"responses":[{"status":200,"contentType":"application/json","description":"A card can return type rich with widget HTML, dimensions and thumbnail metadata. Small size limits or verification links return type link.","fields":[{"name":"version","type":"string","description":"oEmbed protocol version 1.0."},{"name":"type","type":"string","description":"rich for a card widget; link for verification links or restrictive dimensions."},{"name":"provider_name","type":"string","description":"Veil."},{"name":"provider_url","type":"string","description":"Directory base URL."},{"name":"cache_age","type":"integer","description":"Suggested cache lifetime in seconds."},{"name":"title","type":"string","description":"Readable title."},{"name":"author_name","type":"string, optional","description":"Display name when known."},{"name":"author_url","type":"string, optional","description":"Permanent author card URL."},{"name":"html","type":"string, optional","description":"Iframe HTML for type=rich."},{"name":"width","type":"integer, optional","description":"Widget width for type=rich."},{"name":"height","type":"integer, optional","description":"Widget height for type=rich."},{"name":"thumbnail_url","type":"string, optional","description":"Server-rendered card image."},{"name":"thumbnail_width","type":"integer, optional","description":"Thumbnail width in pixels."},{"name":"thumbnail_height","type":"integer, optional","description":"Thumbnail height in pixels."}]}],"responseObjects":[],"errorFormat":"json","errorDetails":[{"status":400,"code":"invalid_parameter","description":"A path, query or body field is missing, malformed or outside its accepted range.","action":"Correct the field named in `error.message` before sending again.","scope":"endpoint"},{"status":401,"code":"invalid_api_key","description":"The bearer credential is malformed, unknown, expired or revoked.","action":"Use an active key. To use anonymous public access, remove `Authorization` entirely. Invalid credentials never fall back automatically.","scope":"optional-api-key"},{"status":403,"code":"api_key_scope","description":"The API key lacks read or verify scope, or the endpoint does not accept bearer keys.","action":"Use the correct scope. Identity writes and key management still require a device signature.","scope":"optional-api-key"},{"status":403,"code":"api_key_suspended","description":"This API key is suspended.","action":"Ask staff to restore it; another key cannot lift an account suspension.","scope":"optional-api-key"},{"status":403,"code":"developer_suspended","description":"The owner’s API account is suspended or the owner card is unavailable.","action":"Check the owner account and any staff restriction. Creating another key does not bypass suspension.","scope":"optional-api-key"},{"status":404,"code":"not_found","description":"The requested card, key, alias, code or resource was not found.","action":"Check the identifier. Temporary codes and previews may already have expired or been used.","scope":"endpoint"},{"status":429,"code":"rate_limited","description":"An anonymous, signed-request or API-key allowance was exceeded.","action":"Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.","scope":"common"},{"status":500,"code":"internal_error","description":"An unexpected server error occurred. Internal details are not returned.","action":"Retry reads with bounded backoff. Check write results before sending a new signed operation.","scope":"common"},{"status":501,"code":"format_not_implemented","description":"Only JSON oEmbed responses are supported.","action":"Request format=json.","scope":"endpoint"},{"status":503,"code":"busy","description":"The application has reached a temporary concurrency or database limit.","action":"Wait `Retry-After` seconds and retry with bounded backoff.","scope":"common"}],"responseHeaders":[{"name":"Content-Type","value":"application/json","description":"Use the declared media type before choosing a parser."},{"name":"Date","value":"HTTP date","description":"Server time. Compare it with your clock when signing requests."},{"name":"Cache-Control","value":"public, max-age=300","description":"Server-rendered previews may be cached for five minutes."},{"name":"Retry-After","value":"integer seconds, on rate_limited or busy","description":"Wait at least this long before retrying. Other 429/503 codes do not necessarily include it."}],"documentationUrl":"https://veil.rip/docs/oembed","supportsBrowserFetch":true,"browserMode":"fetch"}}