Skip to content

Image API

Isaac edited this page Apr 3, 2022 · 3 revisions

Diffbot documentation:

https://www.diffbot.com/dev/docs/image/

Usage

  let image = await diffbot.image({
    url: 'https://www.deviantart.com/up-tchi/art/Coral-village-852927725',
    body: 'optional-html-post-body',
  });
  console.log(image.objects[0].title);
  console.log(image.objects[0].url);
  console.log(image.objects[0].naturalHeight);

Full list of supported parameters:

Param Type Required Description
url string Yes Web page URL of the image to process
fields string[] No Used to specify optional fields to be returned by the Image API. See fields: https://www.diffbot.com/dev/docs/image/#fields
timeout number No Sets a value in milliseconds to wait for the retrieval/fetch of content from the requested URL. The default timeout for the third-party response is 30 seconds (30000).
callback string No Use for jsonp requests. Needed for cross-domain ajax.
proxy string No Used to specify the IP address of a custom proxy that will be used to fetch the target page, instead of Diffbot's default IPs/proxies. (Ex: &proxy=168.212.226.204)
proxyAuth string No Used to specify the authentication parameters that will be used with the proxy specified in the &proxy parameter. (Ex: &proxyAuth=username:password)
body string No Optional HTML markup to pass as POST body
customJS string No This functionality is currently in beta. See docs for details: https://docs.diffbot.com/docs/en/api-image#custom-javascript
customHeaders object No This functionality is currently in beta. See docs for details: https://docs.diffbot.com/docs/en/api-image#custom-headers
Clone this wiki locally