/1/extract

get

https://api.embedly.com/1/extract

Extract allows users to dive into specifics on a site and beyond. With this API we allow developers to extract article text, topics, and retrieve more meta-data about articles, blog posts, and stories.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

url

string

The URL is to retrieve embedding information. This URL must be escaped to ensure that Embedly retrieves the correct link. For example, this Embedly URL.

urls

string

A comma separated list of urls for Embedly to process. Each URL must be escaped, but commas separating URLS must NOT be URL encoded. urls accepts a maximum of 10 urls at a time. Embedly processes these urls in parallel, therefore, it’s quicker to use urls for batched processing.

maxwidth

int32

This is the maximum width of the embed in pixels. maxwidth is used for scaling down embeds so they fit into a certain width. If the container for an embed is 500px you should pass maxwidth=500 in the query parameters.

maxheight

int32

This is the maximum height of the embed in pixels. Functions the same as maxwidth, but for the height of the embed instead. It’s noteworthy that maxwidth is preferred over maxheight.

width

int32

Will scale embeds type rich and video to the exact width that a developer specifies in pixels. Embeds smaller than this width will be scaled up and embeds larger than this width will be scaled down. Note that using this may cause distortion when scaling up embeds.

height

int32

Will scale embeds type rich and video to the exact height that a developer specifies in pixels. Embeds smaller than this height will be scaled up and embeds larger than this height will be scaled down. Note that using this may cause distortion when scaling up embeds.

format

string

The response format – Accepted values: (xml, json)

wmode

string

Will append the wmode value to the flash object. Possible values include window, opaque and transparent.

callback

string

Returns a (jsonp) response format. The callback is the name of the javascript function to execute.

allowscripts

boolean

By default Embedly does not return script embeds for jsonp requests. They just don’t work and cause lots of issues. In some cases, you may need the script tag for saving and displaying later. In order for Embedly to send the script embeds over jsonp add allowscripts=true. Use with care, and this option is only valid when a callback is supplied, otherwise, it is ignored.

autoplay

boolean

This will tell the video/rich media to automatically play when the media is loaded. Accepted values: (true, false) Default: false

words

string

Defaults to 50

The words parameter works by trying to split the description at the closest sentence to that word count

chars

string

chars is much simpler than words. Embedly will blindly truncate a description to the number of characters you specify adding ... at the end when needed.

luxe

boolean

Defaults to false

With luxe Embedly’s iframe is initially loaded with poster image and play button rather than loading the whole embed. When the user clicks play the embed is loaded and starts playing.

secure

boolean

secure allows you to serve embeds with a SSL connection. You can also serve images over SSL with our Display product. You can enable this by adding secure=true.

scheme

string

scheme allows to set the protocol scheme explicity to http or https. By default embeds are sent back protocol-less so that they will work in any page. You can explicity set a protocol by adding scheme=https.

title

string

With title Embedly will set the title response attribute to the open_graph, meta, or twitter title if available in the page. Accepted values: (og, twitter, meta)

description

string

With description Embedly will set the description response attribute to the open_graph, meta, or twitter description if available in the page. Accepted values: (og, twitter, meta)

meta_images

boolean

Defaults to false

Will return only images found in meta tags or an API response if set.

boolean

Defaults to false

Turns on/off player analytics

dnt

boolean

Defaults to false

Turns on/off Do Not Track support within embed

Responses

200200

400400