GET /sites/$site/embeds/render

Get a rendered embed for a site. Note: The current user must have publishing access.

Resource Information

Method GET
Requires authentication? Yes

Method Parameters

Parameter Type Description
$site (int|string) Site ID or domain

Query Parameters

Parameter Type Description
context (string)
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.
embed_url (string) The query-string encoded embed URL to render. Required. Only accepts one at a time.

Response Parameters

Parameter Type Description
embed_url (string) The embed_url that was passed in for rendering.
result (html) The rendered HTML result of the embed.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
403 unauthorized User cannot access this private blog.
403 unauthorized User cannot access this restricted blog
400 invalid_embed Only one embed can be rendered at a time.
400 invalid_embed The requested URL is not an embed.
400 invalid_embed_url The embed_url parameter must be a valid URL.
403 unauthorized Your token must have permission to post on this blog.


curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',

$context  = stream_context_create( $options );
$response = file_get_contents(
$response = json_decode( $response );


    "embed_url": "https:\/\/\/watch?v=SQEQr7c0-dw",
    "result": "<span class=\"embed-youtube\" style=\"text-align:center; display: block;\"><\/iframe><\/span>"