{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/1/display","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"url","type":"string","default":"","desc":"The URL of the image to proxy. The URL must be url-encoded to ensure that Embedly retrieves the correct link.","required":true,"in":"query","ref":"","_id":"564e04e8873c362d005172b0"},{"name":"errorurl","type":"string","default":"","desc":"The URL of the fall back image to use when url fails. The URL must be url-encoded to ensure that Embedly retrieves the correct link.","required":false,"in":"query","ref":"","_id":"564e04e8873c362d005172af"},{"name":"animate","type":"boolean","default":"true","desc":"Setting animate to false will convert the image to the first frame of animation for animated images. Setting this value on non-animated images will have non effect and is safe to do.","required":false,"in":"query","ref":"","_id":"56e03a8d40ba87220064158e"},{"name":"compresspng","type":"boolean","default":"false","desc":"Will run images through pngcompressor. Increases response time.","required":false,"in":"query","ref":"","_id":"56e03a8d40ba87220064158d"},{"name":"Accept","type":"string","default":"image/*","desc":"Please set an \"Accept: image/*\" header when you programmatically make requests to \"i.embed.ly\" to receive raw image data.  Without this, the API responds with an HTML wrapped image tag (security).","required":false,"in":"header","ref":"","_id":"5b732e9e544d650003a9ad14"}],"results":{"codes":[{"status":200,"language":"http","code":"","name":""}]},"settings":"564e0334e512d10d007641d3"},"next":{"description":"","pages":[]},"title":"/1/display","type":"endpoint","slug":"display","excerpt":"The Display endpoint is a simple proxy that allows you to embed insecure images into secure pages without warning and uses a fall back image for images not found.","body":"","updates":["59168f3b4ab6e31900b714a2","59e7cd4e6a8551003061a79b","59e7ef1f2dbcb20010a61c9d"],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"564e031f5eab6e0d0069ca38","category":{"sync":{"isSync":false,"url":""},"pages":["564e01de8980c32b009e8bca","564e031f5eab6e0d0069ca38","564e057a873c362d005172b2","564e05a15eab6e0d0069ca40","564e07b01494cc2b00acb618","56941291d8c04d1700e5adc2","5696aca1cb14e11700f8aa01","56d46a4f73dcd20b00fb8647","56d46a5b8001e30b00896ebb","56f00bd1d58ed32400df6092","56f01568d58ed32400df60c1","56f0194911415c2900969c10"],"title":"API","slug":"api","order":1,"from_sync":false,"reference":true,"_id":"564df3217c8f372b00b934df","project":"564de2dbfe07a81700b5c3a5","__v":12,"createdAt":"2015-11-19T16:04:49.459Z","version":"564de2dbfe07a81700b5c3a8"},"githubsync":"","user":"564de2b4fe07a81700b5c3a4","createdAt":"2015-11-19T17:13:03.145Z","__v":8,"editedParams":true,"editedParams2":true,"project":"564de2dbfe07a81700b5c3a5","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["564de2ddfe07a81700b5c3a9","564df317826645210097a890","564df3217c8f372b00b934df","564e5227c3553e0d003e53ba","5666dac5d784a70d00397bcb","56cd08ddd98d851d00c0c3bd","56e9a50946bfd60e008840a7","5718e37bf8f7de1900683fad","58c3308dfedf070f0043b72c","58ce99c75457d02300560c0a"],"_id":"564de2dbfe07a81700b5c3a8","project":"564de2dbfe07a81700b5c3a5","__v":10,"createdAt":"2015-11-19T14:55:23.838Z","releaseDate":"2015-11-19T14:55:23.837Z"},"parentDoc":null}

get/1/display

The Display endpoint is a simple proxy that allows you to embed insecure images into secure pages without warning and uses a fall back image for images not found.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

url:
required
string
The URL of the image to proxy. The URL must be url-encoded to ensure that Embedly retrieves the correct link.
errorurl:
string
The URL of the fall back image to use when url fails. The URL must be url-encoded to ensure that Embedly retrieves the correct link.
animate:
booleantrue
Setting animate to false will convert the image to the first frame of animation for animated images. Setting this value on non-animated images will have non effect and is safe to do.
compresspng:
booleanfalse
Will run images through pngcompressor. Increases response time.

Headers

Accept:
stringimage/*
Please set an "Accept: image/*" header when you programmatically make requests to "i.embed.ly" to receive raw image data. Without this, the API responds with an HTML wrapped image tag (security).