Skip to content

oEmbed

Retrieve rich embed metadata for a supported gallery content URL. This is different from the worktaster and events iframe integrations.

The returned type is rich and version is 1.0. Required fields include html, width and height.

Examples

The following placeholder URL is illustrative, not a real supported asset. Replace it with a supported gallery URL. The specification does not list accepted URL patterns or format values.

curl --fail-with-body --get \
  --data-urlencode "url=https://gallery.dabbble.app/" \
  --data-urlencode "maxwidth=800" \
  --data-urlencode "maxheight=700" \
  "https://galleryapi.dabbble.app/v1/oembed"
const url = new URL('https://galleryapi.dabbble.app/v1/oembed');
url.search = new URLSearchParams({
  url: 'https://gallery.dabbble.app/',
  maxwidth: '800', maxheight: '700'
});
const response = await fetch(url, { signal: AbortSignal.timeout(20000) });
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const embed = await response.json();
console.log(embed);
import json
from urllib.parse import urlencode
from urllib.request import urlopen
query = urlencode({
    'url': 'https://gallery.dabbble.app/',
    'maxwidth': 800, 'maxheight': 700
})
with urlopen('https://galleryapi.dabbble.app/v1/oembed?' + query, timeout=20) as response:
    embed = json.load(response)
print(embed)

Rendering Guidance

Treat html as external HTML. Validate the provider and apply your site's security policy before rendering it. Do not render arbitrary provider HTML selected by an untrusted URL without review. Backend fetches of visitor-controlled URLs also need destination validation.

Requested maximum dimensions do not establish automatic iframe resizing. The specification does not document height messaging or responsive resizing behaviour.

Although url is marked optional, the schema does not explain useful behaviour when it is omitted.

Endpoint Reference

GET /v1/oembed

Oembed

Authentication: No security requirement declared.

Parameter Location Type Required Details
url query string No
format query string or null No
maxwidth query integer or null No
maxheight query integer or null No
Status Description Response schema
200 OK OembedOut

Response Schema

OembedOut

Field Type Required Details
type string Yes Fixed: rich.
version string Yes Fixed: 1.0.
title string or null No
author_name string or null No
author_url string or null No
provider_name string or null No
provider_url string or null No
cache_age string or null No
thumbnail_url string or null No
thumbnail_width string or null No
thumbnail_height string or null No
html string Yes
width integer Yes
height integer Yes