oEmbed

Get oEmbed data for the given URL

Changed on

Get oEmbed data for the given URL. This is the oEmbed 1.0 consumer endpoint.

get/oembed/

Request

Query parameters

urlstring required

The URL of the content to retrieve oEmbed data for.

Response

OK

versionstring

oEmbed version (always '1.0')

typestring

oEmbed type (e.g. 'rich')

provider_namestring
provider_urlstring
author_namestring
author_urlstring
htmlstring

HTML embed code

referrerstring
cache_ageinteger

Recommended cache lifetime in seconds

Changes

    • info

      api operation id get_oembed_ removed and replaced with getOembed

    • info

      added the new optional header request parameter XF-Api-User to all path's operations

    • info

      added the new optional query request parameter api_bypass_permissions to all path's operations

    • breaking

      added the new required query request parameter url

    • info

      api tag oEmbed added

    • info

      api tag oembed removed

    • info

      added the media type application/json for the response with the status