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

Basics:

api_key and url are required parameters. If you'd like to secure your API key in your JavaScript code, you can use 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 features:


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 media=0 parameter below for a card without media, or simply disable all apps in your API settings.
omit_script=1 Excludes embed.js from HTML codes, if you load it yourself. It also forces script-based embeds be returned as <iframe> instead (useful e.g. for React.js)
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

Content filters:

language= Accept-Language - default is en-US. Sets rich media interface language for number of publishers. For all publishers, makes Iframely parsers to request HTTP responses in that locale as top choice in accept-language header (many sites render different meta depending on locale).

The parameter value is an ISO 639-1 fully specified locale of two-letter language code and two-letter region code. For example, fr-CA or fr-FR are both valid values. For some languages, Iframely might accept just the two-letter language code and add the default region code automatically.

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 app embeds AND simple media, such as photos or video. This option will make Iframely return actual media in the html field instead of branded embeds. It affects, for example, Instagram, Tumblr, Imgur, Pinterest (for videos), etc.
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 autoplay media and will try to return it as primary html. Check for autoplay in primary rel to verify. Available only with Iframely API endpoint.
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)

Helpers:

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.
callback Name of a JavaScript function, if you’d like response to be wrapped as JSONP
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.

Most frequently requested adjustments are available for self-service in your settings. For other cases, Iframely team can configure the exact embeds you like for your favourite publishers. Ask away.

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.