Additional API parameters
In addition to your API settings, you can change what you get as API response for each API request or many of the individual publishers. If not given with an API call, your defaults will be used. If you haven't set up and saved your preferences at least once, the default cloud-wide settings will be used.
For individual API calls
key parameter, which should be equal to MD5 hash of your actual API key. See how to secure your API key.
You may add the following optional values as query-string parameters with your HTTP requests.
|iframe=1||Explicitely activates Smart iFrames. Embed will be wrapped into Iframely iFrame or a URLs preview will be generated as a Summary Card|
|iframe=amp||Formats HTML code output for Accelerated Mobile Pages framework|
|iframe=card||Wraps rich media into a summary card. Works for players, images and some apps.
HTML-based embeds for Twitter, Facebook will be left as is. See
|omit_script=1||Excludes embed.js from HTML codes, if you load it yourself. It also forces script-based embeds be returned as
|omit_css=1||Formats HTML with CSS classnames instead of inline styles. Lets you fine-tune embed codes via CSS. Makes Twitter and Facebook not cause flicks on the page.|
|align=left||Skips default center aligning of Twitter, Facebook, Instagram and other app embeds|
|playerjs=1||Activates Player.js events to control players where possible. Requires iFrame.|
|lazy=1||Activates lazy-loading when Iframely returns a smart iFrame|
The parameter value is an ISO 639-1 fully specified locale of two-letter language code and two-letter region code. For example,
Please test your locale choice with Twitter, Facebook, YouTube and TED before pushing it live. Instagram should also use either this language, or the one from user's browser.
|ssl=1||Returns only embeds that can be used under HTTPs without active SSL mixed-content warnings (images and mp4 videos trigger only passive warnings and thus will pass this check)|
|html5=1||Returns only embeds that can be viewed on mobile devices or desktops without Flash plugin installed|
|media=1||"Prefer media-only". For some publishers, Iframely knows status-like
|media=0||Disables any rich media from a publisher and forces URL to try and resolve into a summary card instead.|
|autoplay=1||Gives preference to
|maxwidth=||In pixels, returns only embeds that do not exceed this width. It affects the rare cases of fixed-width embeds as in most cases Iframely gives the responsive embed codes. It doesn't limit the size of embed because many WordPress sites have this setting wrong (&omit_css instead)|
|origin=||Optional tag text value that will help you later search links in your dashboard. It represents the hashtag E.g. project or chat room name, category, app, if you got several, etc.|
|format=xml||For oEmbed API only, if you'd like to get your response as XML|
For individual embeds publishers
Number of publishers give different embedding options. By default, Iframely provides embeds that we believe is the best fit for most common use case. But you, of course, might want it differently.
For individual URLs
In addition your default account's settings and parameters, your users may toggle the embedding settings for individual URL to get exact variant they need for their specific post.
It is done by adding Iframely's query-string command direclty inside the URL. Read about "More/Less" toggle and share with your users.