shutterstock-api.ComputerVisionApi

All URIs are relative to https://api.shutterstock.com.

Method	HTTP request	Description
`getKeywords`	`GET /v2/cv/keywords`	List suggested keywords
`getSimilarImages`	`GET /v2/cv/similar/images`	List similar images
`getSimilarVideos`	`GET /v2/cv/similar/videos`	List similar videos
`uploadEphemeralImage`	`POST /v2/images`	Upload ephemeral images
`uploadImage`	`POST /v2/cv/images`	Upload images

ComputerVisionApi.getKeywords

KeywordDataList ComputerVisionApi.getKeywords(asset_id)

List suggested keywords

This endpoint returns a list of suggested keywords for a media item that you specify or upload.

Example

const sstk = require('shutterstock-api');

// To use HTTP basic authorization:
sstk.setBasicAuth(client_id, client_secret);

// To use OAuth access token authorization:
sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const api = new sstk.ComputerVisionApi();

const asset_id = "U6ba16262e3bc2db470b8e3cfa8aaab25"; // Object | The asset ID or upload ID to suggest keywords for


api.getKeywords(asset_id)
  .then((data) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });

Parameters

Name	Type	Description
asset_id (required)	Object	The asset ID or upload ID to suggest keywords for

Accepted authentication

Basic
OAuth (No scope required.)

HTTP request headers

Accept: application/json

Return type

KeywordDataList

Example response

{
  "data" : [ "nature", "wildlife", "animal", "cute", "bamboo", "panda", "china", "wild", "endangered", "black", "bear" ]
}

ComputerVisionApi.getSimilarImages

ImageSearchResults ComputerVisionApi.getSimilarImages(asset_id, queryParams)

List similar images

This endpoint returns images that are visually similar to an image that you specify or upload.

Example

const sstk = require('shutterstock-api');

// To use HTTP basic authorization:
sstk.setBasicAuth(client_id, client_secret);

// To use OAuth access token authorization:
sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const api = new sstk.ComputerVisionApi();

const asset_id = "U6ba16262e3bc2db470b8e3cfa8aaab25"; // String | The asset ID or upload ID to find similar images for

const queryParams = { 
  'license': ["[\"commercial\"]"], // [String] | Show only images with the specified license
  'safe': true, // Boolean | Enable or disable safe search
  'language': "es", // String | Language for the keywords and categories in the response
  'page': 1, // Number | Page number
  'per_page': 20, // Number | Number of results per page
  'view': "minimal" // String | Amount of detail to render in the response
};

api.getSimilarImages(asset_id, queryParams)
  .then((data) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });

Parameters

Name	Type	Description
asset_id (required)	String	The asset ID or upload ID to find similar images for
license	[String]	Show only images with the specified license, defaults to ["commercial"] Valid values: "commercial", "editorial"
safe	Boolean	Enable or disable safe search, defaults to true
language	String	Language for the keywords and categories in the response Valid values: "ar", "bg", "bn", "cs", "da", "de", "el", "en", "es", "fi", "fr", "gu", "he", "hi", "hr", "hu", "id", "it", "ja", "kn", "ko", "ml", "mr", "nb", "nl", "or", "pl", "pt", "ro", "ru", "sk", "sl", "sv", "ta", "te", "th", "tr", "uk", "ur", "vi", "zh", "zh-Hant"
page	Number	Page number, defaults to 1
per_page	Number	Number of results per page, defaults to 20
view	String	Amount of detail to render in the response, defaults to minimal Valid values: "minimal", "full"

Accepted authentication

Basic
OAuth (No scope required.)

HTTP request headers

Accept: application/json

Return type

ImageSearchResults

Example response

{
  "data" : [ {
    "id" : "1572478477",
    "aspect" : 1.5,
    "assets" : {
      "preview" : {
        "height" : 300,
        "url" : "https://image.shutterstock.com/display_pic_with_logo/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
        "width" : 450
      },
      "small_thumb" : {
        "height" : 67,
        "url" : "https://thumb7.shutterstock.com/thumb_small/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
        "width" : 100
      },
      "large_thumb" : {
        "height" : 100,
        "url" : "https://thumb7.shutterstock.com/thumb_large/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
        "width" : 150
      },
      "mosaic" : {
        "height" : 167,
        "url" : "https://image.shutterstock.com/image-photo/stock-photo-cropped-image-of-woman-gardening-250nw-1572478477.jpg",
        "width" : 250
      },
      "huge_thumb" : {
        "height" : 260,
        "url" : "https://image.shutterstock.com/image-photo/cropped-image-woman-gardening-260nw-1572478477.jpg",
        "width" : 390
      },
      "preview_1000" : {
        "url" : "https://ak.picdn.net/shutterstock/photos/1572478477/watermark_1000/1706028c641ea2f443057287c67d9b91/preview_1000-1572478477.jpg",
        "width" : 1000,
        "height" : 667
      },
      "preview_1500" : {
        "url" : "https://image.shutterstock.com/z/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
        "width" : 1500,
        "height" : 1000
      }
    },
    "contributor" : {
      "id" : "250738318"
    },
    "description" : "cropped image of woman gardening",
    "image_type" : "photo",
    "has_model_release" : true,
    "media_type" : "image"
  } ],
  "page" : 1,
  "per_page" : 5,
  "search_id" : "749090bb-2967-4a20-b22e-c800dc845e10",
  "spellcheck_info" : { },
  "total_count" : 45
}

ComputerVisionApi.getSimilarVideos

VideoSearchResults ComputerVisionApi.getSimilarVideos(asset_id, queryParams)

List similar videos

This endpoint returns videos that are visually similar to an image that you specify or upload.

Example

const sstk = require('shutterstock-api');

// To use HTTP basic authorization:
sstk.setBasicAuth(client_id, client_secret);

// To use OAuth access token authorization:
sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const api = new sstk.ComputerVisionApi();

const asset_id = "U6ba16262e3bc2db470b8e3cfa8aaab25"; // String | The asset ID or upload ID to find similar videos for

const queryParams = { 
  'license': ["[\"commercial\"]"], // [String] | Show only videos with the specified license
  'safe': true, // Boolean | Enable or disable safe search
  'language': "es", // String | Language for the keywords and categories in the response
  'page': 1, // Number | Page number
  'per_page': 20, // Number | Number of results per page
  'view': "minimal" // String | Amount of detail to render in the response
};

api.getSimilarVideos(asset_id, queryParams)
  .then((data) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });

Parameters

Name	Type	Description
asset_id (required)	String	The asset ID or upload ID to find similar videos for
license	[String]	Show only videos with the specified license, defaults to ["commercial"] Valid values: "commercial", "editorial"
safe	Boolean	Enable or disable safe search, defaults to true
language	String	Language for the keywords and categories in the response Valid values: "ar", "bg", "bn", "cs", "da", "de", "el", "en", "es", "fi", "fr", "gu", "he", "hi", "hr", "hu", "id", "it", "ja", "kn", "ko", "ml", "mr", "nb", "nl", "or", "pl", "pt", "ro", "ru", "sk", "sl", "sv", "ta", "te", "th", "tr", "uk", "ur", "vi", "zh", "zh-Hant"
page	Number	Page number, defaults to 1
per_page	Number	Number of results per page, defaults to 20
view	String	Amount of detail to render in the response, defaults to minimal Valid values: "minimal", "full"

Accepted authentication

Basic
OAuth (No scope required.)

HTTP request headers

Accept: application/json

Return type

VideoSearchResults

Example response

{
  "data" : [ {
    "id" : "1033184651",
    "aspect" : 1.778,
    "aspect_ratio" : "16:9",
    "assets" : {
      "thumb_webm" : {
        "url" : "https://ak.picdn.net/shutterstock/videos/1033184651/thumb/stock-footage-camera-follows-hipster-millennial-young-woman-in-orange-jacket-running-up-on-top-of-mountain-summit.webm"
      },
      "thumb_mp4" : {
        "url" : "https://ak.picdn.net/shutterstock/videos/1033184651/thumb/stock-footage-camera-follows-hipster-millennial-young-woman-in-orange-jacket-running-up-on-top-of-mountain-summit.mp4"
      },
      "preview_webm" : {
        "url" : "https://ak.picdn.net/shutterstock/videos/1033184651/preview/stock-footage-camera-follows-hipster-millennial-young-woman-in-orange-jacket-running-up-on-top-of-mountain-summit.webm"
      },
      "preview_mp4" : {
        "url" : "https://ak.picdn.net/shutterstock/videos/1033184651/preview/stock-footage-camera-follows-hipster-millennial-young-woman-in-orange-jacket-running-up-on-top-of-mountain-summit.mp4"
      },
      "thumb_jpg" : {
        "url" : "https://ak.picdn.net/shutterstock/videos/1033184651/thumb/12.jpg"
      },
      "preview_jpg" : {
        "url" : "https://ak.picdn.net/shutterstock/videos/1033184651/thumb/12.jpg"
      }
    },
    "contributor" : {
      "id" : "4411978"
    },
    "description" : "Camera follows hipster millennial young woman in orange jacket running up on top of mountain summit at sunset, jumps on top of rocks, raises arms into air, happy and drunk on life, youth and happiness",
    "duration" : 14.081,
    "has_model_release" : true,
    "media_type" : "video"
  } ],
  "page" : 1,
  "per_page" : 5,
  "total_count" : 123,
  "search_id" : "749090bb-2967-4a20-b22e-c800dc845e10"
}

ComputerVisionApi.uploadEphemeralImage

ImageCreateResponse ComputerVisionApi.uploadEphemeralImage(body)

Upload ephemeral images

Deprecated; use POST /v2/cv/images instead. This endpoint uploads an image for reverse image search. The image must be in JPEG or PNG format. To get the search results, pass the ID that this endpoint returns to the GET /v2/images/{id}/similar endpoint.

Example

const sstk = require('shutterstock-api');

// To use HTTP basic authorization:
sstk.setBasicAuth(client_id, client_secret);

// To use OAuth access token authorization:
sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const api = new sstk.ComputerVisionApi();

const body = new ShutterstockApiReference.ImageCreateRequest(); // ImageCreateRequest | The image data in JPEG or PNG format


api.uploadEphemeralImage(body)
  .then((data) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });

Parameters

Name	Type	Description
body (required)	ImageCreateRequest	The image data in JPEG or PNG format

Accepted authentication

Basic
OAuth (No scope required.)

HTTP request headers

Content-Type: application/json
Accept: application/json

Return type

ImageCreateResponse

Example response

{
  "id" : "Udb14e1c3540bdbf82b4b3fe12d3a44f2"
}

ComputerVisionApi.uploadImage

ComputerVisionImageCreateResponse ComputerVisionApi.uploadImage(body)

Upload images

This endpoint uploads an image for reverse image or video search. Images must be in JPEG or PNG format. To get the search results, pass the upload ID that this endpoint returns to the GET /v2/cv/similar/images or GET /v2/cv/similar/videos endpoints. Contact us for access to this endpoint.

Example

const sstk = require('shutterstock-api');

// To use HTTP basic authorization:
sstk.setBasicAuth(client_id, client_secret);

// To use OAuth access token authorization:
sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const api = new sstk.ComputerVisionApi();

const body = new ShutterstockApiReference.ImageCreateRequest(); // ImageCreateRequest | A Base 64 encoded jpeg or png; images can be no larger than 10mb and can be no larger than 10,000 pixels in width or height


api.uploadImage(body)
  .then((data) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });

Parameters

Name	Type	Description
body (required)	ImageCreateRequest	A Base 64 encoded jpeg or png; images can be no larger than 10mb and can be no larger than 10,000 pixels in width or height

Accepted authentication

Basic
OAuth (No scope required.)

HTTP request headers

Content-Type: application/json
Accept: application/json

Return type

ComputerVisionImageCreateResponse

Example response

{
  "upload_id" : "Udb14e1c3540bdbf82b4b3fe12d3a44f2"
}

Files

ComputerVisionApi.md

Latest commit

History

ComputerVisionApi.md

File metadata and controls

shutterstock-api.ComputerVisionApi

ComputerVisionApi.getKeywords

Example

Parameters

Accepted authentication

HTTP request headers

Return type

Example response

ComputerVisionApi.getSimilarImages

Example

Parameters

Accepted authentication

HTTP request headers

Return type

Example response

ComputerVisionApi.getSimilarVideos

Example

Parameters

Accepted authentication

HTTP request headers

Return type

Example response

ComputerVisionApi.uploadEphemeralImage

Example

Parameters

Accepted authentication

HTTP request headers

Return type

Example response

ComputerVisionApi.uploadImage

Example

Parameters

Accepted authentication

HTTP request headers

Return type

Example response