{"__v":1,"_id":"564e01de8980c32b009e8bca","category":{"__v":7,"_id":"564df3217c8f372b00b934df","project":"564de2dbfe07a81700b5c3a5","version":"564de2dbfe07a81700b5c3a8","pages":["564e01de8980c32b009e8bca","564e031f5eab6e0d0069ca38","564e057a873c362d005172b2","564e05a15eab6e0d0069ca40","564e07b01494cc2b00acb618","56941291d8c04d1700e5adc2","5696aca1cb14e11700f8aa01"],"reference":false,"createdAt":"2015-11-19T16:04:49.459Z","from_sync":false,"order":1,"slug":"api","title":"API"},"project":"564de2dbfe07a81700b5c3a5","user":"564de2b4fe07a81700b5c3a4","version":{"__v":5,"_id":"564de2dbfe07a81700b5c3a8","project":"564de2dbfe07a81700b5c3a5","createdAt":"2015-11-19T14:55:23.838Z","releaseDate":"2015-11-19T14:55:23.837Z","categories":["564de2ddfe07a81700b5c3a9","564df317826645210097a890","564df3217c8f372b00b934df","564e5227c3553e0d003e53ba","5666dac5d784a70d00397bcb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"createdAt":"2015-11-19T17:07:42.454Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"$.embedly.oembed('url', {});","language":"javascript"}]},"results":{"codes":[{"name":"","code":"{\n  \"provider_url\": \"http://blog.embed.ly\",\n  \"lead\": null,\n  \"language\": \"English\",\n  \"original_url\": \"http://blog.embed.ly/javascript-hackathon-downcityjs-betaspring\",\n  \"url\": \"http://blog.embed.ly/javascript-hackathon-downcityjs-betaspring\", \n  \"entities\": [\n    {\"count\": 4, \"name\": \"Aaron\"},\n    {\"count\": 1, \"name\": \"Vinh\"},\n    {\"count\": 1, \"name\": \"Reddit\"},\n    {\"count\": 1, \"name\": \"Kyle Nichols\"},\n    {\"count\": 1, \"name\": \"Kawan\"}\n  ],\n \t\"safe\": true,\n  \"provider_display\": \"blog.embed.ly\",\n  \"related\": [],\n  \"keywords\": [\n    {\"score\": 31, \"name\": \"api\"},\n    {\"score\": 28, \"name\": \"embed\"},\n    {\"score\": 21, \"name\": \"aaron\"},\n    {\"score\": 14, \"name\": \"best\"},\n    {\"score\": 10, \"name\": \"thumbwar\"},\n    {\"score\": 10,\"name\": \"friends\"}\n  ],\n \n  \"title\": \"DowncityJS Hackathon Recap - Embedly\",\n  \"description\": \"We provided our API for.....\",\n  \"content\": \"<div><strong>We</strong> provi...</div>\",\n   \"authors\": [{\n    \"url\": \"http://posterous.com/users/iHySgjJhRuY0q\",\n  \t\"name\": \"Nina Stepanov\"}\n   ],\n  \"favicon_url\": \"http://blog.embed.ly/images/favicon.png\",\n  \"favicon_colors\": [\n    {\"color\": [243, 245, 245], \"weight\": 0.68701171875},\n    {\"color\": [10, 169, 25], \"weight\": 0.223388671875},\n    {\"color\": [0, 100, 6], \"weight\": 0.089599609375}\n  ],\n\n  \"media\": {},\n  \"offset\": null,\n  \"published\": 1360022400000,\n  \"images\": [ {\n    \"caption\":null,\n    \"url\":\"https://lh3.googleusercontent.com/MaaMmP0N4psfPqQOUqegiz3q-SxnRd3sFn-XNKy92XLXo-\n    R6dZIcFv7PkvgleeCqynGsUj4s9GUTnL__W77OpjmaTcBgis98nhudlkwsZp7-CNCqihX1zalDbQ\",\n    \"height\":768,\n    \"width\":1024,\n    \"colors\":[{\n        \"color\":[ 14, 16, 18],\n        \"weight\":0.311767578125\n    \t},\n      {\n        \"color\":[238, 232, 203],\n        \"weight\":0.131103515625\n      }],\n    \t\"entropy\":6.568857137759403,\n    \t\"size\":228025\n   }],\n  \n  \"provider_name\": \"Embed\",\n  \"cache_age\": 86301,\n  \"type\": \"html\"\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"564de4a9fe07a81700b5c3b2","required":false,"desc":"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.","default":"","type":"string","name":"url"},{"_id":"564df12e7441dc350097531b","required":false,"desc":"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.","default":"","type":"string","name":"urls"},{"_id":"564de4a9fe07a81700b5c3b1","required":false,"desc":"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.","default":"","type":"int","name":"maxwidth"},{"_id":"564df12e7441dc350097531a","required":false,"desc":"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.","default":"","type":"int","name":"maxheight"},{"_id":"564df2897441dc350097531f","required":false,"desc":"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.","default":"","type":"int","name":"width"},{"_id":"564df2897441dc350097531e","required":false,"desc":"The response format – Accepted values: (xml, json)","default":"","type":"string","name":"format"},{"_id":"564df2897441dc350097531d","required":false,"desc":"Will append the wmode value to the flash object. Possible values include window, opaque and transparent.","default":"","type":"string","name":"wmode"},{"_id":"564dfad332e48b0d005f9db0","required":false,"desc":"Returns a (jsonp) response format. The callback is the name of the javascript function to execute.","default":"","type":"string","name":"callback"},{"_id":"564dfad332e48b0d005f9daf","required":false,"desc":"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.","default":"","type":"boolean","name":"allowscripts"},{"_id":"564dfad332e48b0d005f9dae","required":false,"desc":"This will tell the video/rich media to automatically play when the media is loaded. Accepted values: (true, false) Default: false","default":"","type":"boolean","name":"autoplay"},{"_id":"564dfad332e48b0d005f9dad","required":false,"desc":"The words parameter works by trying to split the description at the closest sentence to that word count","default":"50","type":"string","name":"words"},{"_id":"564dfad332e48b0d005f9dac","required":false,"desc":"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.","default":"","type":"string","name":"chars"},{"_id":"564dfad332e48b0d005f9dab","required":false,"desc":"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.","default":"0","type":"boolean","name":"luxe"},{"_id":"564dfad332e48b0d005f9daa","required":false,"desc":"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.","default":"","type":"boolean","name":"secure"},{"_id":"564dfad332e48b0d005f9da9","required":false,"desc":"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.","default":"","type":"string","name":"scheme"},{"_id":"569fbbe9650e1d1900f96bba","required":false,"desc":"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)","default":"","type":"string","name":"title"},{"_id":"569fbbe9650e1d1900f96bb9","required":false,"desc":"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)","default":"","type":"string","name":"description"}],"url":"/1/extract"},"order":1,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Try out our handy [Extract API Explorer](http://embed.ly/docs/explore/extract). It's awesome and will allow you to preview the response of any URL.\\n\\nGo to the [Extract API Explorer](http://embed.ly/docs/explore/extract)\",\n  \"title\": \"Want to try out the Extract API?\"\n}\n[/block]","excerpt":"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.","slug":"extract","type":"get","title":"/1/extract"}

get/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.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

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:
Integer
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:
Integer
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:
Integer
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.
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:
String50
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:
Boolean0
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)

Examples


Result Format


Documentation

[block:callout] { "type": "success", "body": "Try out our handy [Extract API Explorer](http://embed.ly/docs/explore/extract). It's awesome and will allow you to preview the response of any URL.\n\nGo to the [Extract API Explorer](http://embed.ly/docs/explore/extract)", "title": "Want to try out the Extract API?" } [/block]