Depositphotos Enterprise Solution API 

Introduction 

These guidelines describe the use of API for working with Depositphotos files. These guidelines are intended for developers familiar with HTTP and JSON data transfer technologies and possessing basic knowledge of programming in any of programming languages.

Enterprise API is the application access interface, which allows registered corporate clients to work with Depositphotos’ content and licenses.

To get access to Enterprise API endpoint, you need a corresponding Enterprise API key. Along with login and password, Enterprise API key provides access to Enterprise API features. Details are given below.

Enterprise API includes features for searching files in the Depositphotos database, for content licensing, issuing of invoices and licensing, transfer of rights (licences), and management of working groups within one company (or corporate structure.)

General information 

Registration 

In order to work with Depositphotos as a corporate client, you need an Enterprise account at Depositphotos and an access key to Enterprise API (you can get it from your manager.)

After obtaining username, password and the API key, you can start working with Enterprise API.

General principles for working with Enterprise API 

All Enterprise API calls are performed through HTTPS protocol with GET or POST parameters set. API returns a response in JSON format. All requests must be sent to the following base url: https://api.depositphotos.com

There are two mandatory parameters for all API methods

dp_apikey:: is an API key, which is issued by a manager to a user after his/her registration on Depositphotos
dp_command:: API method (command) ID

For methods, which require user authorization, there is one more mandatory parameter required:

dp_session_id:: unique session ID, which will be in response after logging in

For requests you can use either form-data or json format for all variables. But if you want to use JSON format, you should:

set the Content-Type header to application/json
pass dp_apikey and dp_command parameters in the URL (i.e. https://api.depositphotos.com?dp_apikey=123&dp_command=loginEnterprise)

Example of request with JSON format:

curl --silent -H 'content-type: application/json' \
'https://api.depositphotos.com?dp_command=loginEnterprise&dp_apikey=e0a1bdd9923bc601293cd053ffa4eaf6e0a1bdd1' \
-d '{"dp_login_user": "something.similar.to.your.email", "dp_login_password": "yourSecurePassword"}'

Example of request with form-data format:

curl --silent https://api.depositphotos.com \
-d 'dp_command=loginEnterprise&dp_apikey=e0a1bdd9923bc601293cd053ffa4eaf6e0a1bdd1&dp_login_user=your.login&dp_login_password=123456'

One more example. The request with form-data format and dp_command/dp_apikey sent in the URL:

curl --silent 'https://api.depositphotos.com?dp_command=loginEnterprise&dp_apikey=e0a1bdd9923bc601293cd053ffa4eaf6e0a1bdd1' \
-d 'dp_login_user=your.login&dp_login_password=123456'

All API methods can return two different results: success or failure (stated in the ‘type’ variable of response). You should rely on the ‘type’ variable to determine the result of the request, not on response HTTP code.

Each ‘success’ result contains specific parameters for each API method, but following parameters are general for all API methods:

timestamp:: current date and time in the “YYYY-MM-DD HH:MM:SS” format
version:: API version; the most up-to-date version is 1.3
type:: ‘success’ for successful requests, ‘failure’ if an error occurs

Example of an error

"error": {
    "errorcode": error code
    "errormsg": error message
    "exception": error type
}

Notes on parameters for API methods

bool: will be considered TRUE for “1”, FALSE for “0”.
array: standard array of http-request. Example: param_a[]=val1&param_a[]=val2&param_b[first_key]=val3&param_b[second_key]=val4

User authentication 

Any actions with files, as well as many other actions require user authentication. User authentication returns a unique session ID. Session ID remains valid for three hours. So, to provide uninterrupted work, it’s necessary to set up automated API user login in 1-3 hours.

loginEnterprise 

User authentication with a login, password, and API key. Returns a unique session ID

Request

string	dp_command	Command name ‘loginEnterprise’
string	dp_apikey	API key
string	dp_login_user	Application user login
string	dp_login_password	Application user password

Response

{
    "timestamp": "2013-03-13 06:49:19",
    "version": "1.3",
    "type": "success",
    "apiKey": "0cbc785ec3776c276bf2f",
    "sessionid": "cfaa06635e3c81b08",
    "userid": "100151"
}

Logout is performed using the request:

logout 

Logout (close API session)

Request

string	dp_command	Command name ‘logout’
string	dp_apikey	API key
string	dp_session_id	Session ID

Response

{
    "timestamp": "2013-03-13 06:49:19",
    "version": "1.3",
    "type": "success",
    "apiKey": "0cbc785ec3776c276bf2f"
}

Working with user groups 

getUserEnterpriseGroup 

Getting information on the group the user belongs to (type of payment, balance, vat, etc.)

Request

string	dp_command	Command name ‘getUserEnterpriseGroup’
string	dp_apikey	API key
string	dp_session_id	Session ID

Response

{
     "timestamp": "2013-03-13 06:49:19",
     "version": "1.3",
     "type": "success",
     "group": [
         "groupId": 12345,
         "money": 12345.12,
         "profileId": 12345,
         "isPostpayment": true,
         "balance": 12345.12,
         "vatNumber": "AX-1234",
         "vatRate": "5.5",
         "vatEnabled": true
     ]
}

getEnterpriseUserData 

This method is used to get account data of the user belonging to the group

Request

string	dp_command	Command name ‘getEnterpriseUserData’
string	dp_apikey	API key
string	dp_session_id	Session ID
int	dp_user_id	Optional. Default - get info about current user

Response

{
    "timestamp": "2018-05-05 14:09:44",
    "version": "1.3",
    "type": "success",
    "data": {
        "username": "Stew"
        "firstName": "Steave"
        "lastName": "Rivera"
        "city": "Futufal"
        "avatarBig":"https://static.depo.../storage/avatars/1369/1307/p_13607.jpg?15139"
        "avatarSmall":"https://static.depos.../storage/avatars/1369/13607/m_1607.jpg?15246139"
        "occupation": "Futufal"
        "avatar": "https://static.depo.../storage/avatars/1369/1307/p_13607.jpg?15139"
        "userId": "13692607"
        "address": "537 Pezis Center"
        "email": "test3@depositphotos.com"
        "phone": "+38012469843094040"
        "state": "Ghg"
        "zip": "07190"
        "registered": "1502183924"
        "enterpriseLite": {
            "groupId": 1570484
       }
        "country": "RU",
        "businessName": "Qwerty"
        "timezone": "Europe/Kiev"
        "website": "wedsite"
        "industry": "Business Services"
        "biography": "B0499144"
        "vatNumber": null
    }
}

Working with files 

License types and content licensing prices are stipulated in the agreement.

If you work on a prepaid basis (“Prepaid”), you need positive account balance to license the content. If you work with on a postpaid basis, an invoice for all licensed content is issued in the end of the month.

search 

Content search The method is designed to search content files by given parameters.

Required at least one of ‘dp_search_query’, ‘dp_search_user’, ‘dp_search_username’ parameters.

Request

string	dp_apikey	Client API key
string	dp_command	Command name ‘search’
string	dp_domain	Optional. Default is “depositphotos.com”. Domain name of one of CDN servers available (e.g. imgcontent.net)
string	dp_search_query	A phrase in English, e.g. “woman hands” OR item id which we are looking for
int	dp_search_sort	Optional. Default is 4. Definition of the sort type (number from 1 to 6, each number equals to sort type)	1 is for ‘best_match’ 4 is for ‘best_sales’ 5 is for ‘newest’ 6 is for ‘undiscovered’
int	dp_search_limit	Optional. Default is 100. A limit to the number of returned search results
string	dp_search_offset	Optional. Default is 0. An offset for the first result to return, after sorting the found set.
int	dp_search_color	Optional. Search by the dominant color of the image. Available colors in table below.
bool	dp_search_nudity	Optional. Default is 0. If false, any search results containing nudity will be hidden, otherwise all images.
int	dp_search_user	Optional. Search by the author, using an author identifier (e.g. 1000942)
string	dp_search_username	Optional. Search by username of DepositPhotos user
string	dp_search_orientation	Optional. Search by the image orientation. ‘horizontal’ or ‘vertical’ or ‘square’
string	dp_search_imagesize	Optional. Search by the image size. Sets minimum image size. ‘s’ or ‘m’ or ‘l’ or ‘xl’
string	dp_exclude_keywords	Optional. Keywords to exclude, comma or space separated.
bool	dp_search_photo	Optional. Default is true. If true, the search results will include JPEG images. If false - exclude.
bool	dp_search_vector	Optional. Default is true . If true, the search results will include vector images. If false - exclude.
bool	dp_search_video	Optional. Default is false. If true, the search results will include videos. If false - exclude.
bool	dp_search_editorial	Optional. If true, the search results will include only editorial items. If false - exclude. If not passed, this filter won’t be applied.
string	dp_tracking_url	Optional. Affiliate tracking link.
bool	dp_full_info	Optional. Default is false. Return full info about items.
string	dp_watermark	Optional. Watermark to use: depositphotos or neutral. Default is neutral.
string	dp_translate_items	Optional. Default is false. If true: title, description and categories will be translated (if translation exists) to language dp_lang
string	dp_lang	Optional. Default is ‘en’. Language for translation (de, ru, fr, sp, zh (for chinese) etc.)
bool	dp_search_correction	Optional. Default is ‘1’. Enable auto correction of search phrase.
int	dp_search_height	Optional. Minimum image height with units in dp_search_dimension_units.
int	dp_search_width	Optional. Minimum image width with units in dp_search_dimension_units.
int	dp_search_max_height	Optional. Maximum image height with units in dp_search_dimension_units.
int	dp_search_max_width	Optional. Maximum image width with units in dp_search_dimension_units.
string	dp_search_dimension_units	Optional. Default = ‘px’. Units for min and max image search size. Px to inc treats as 300 DPI. [ ‘px’ or ‘inch’ or ‘cm’ ]
string	dp_image_url	Optional. Search by image.
string	dp_search_gender	Optional. People gender ‘male’ or ‘female’ or ‘both’
bool	dp_search_people_only	Optional. Only people must be present
str\|int	dp_search_age	Optional. People age: ‘infant’ or ‘child’ or ‘teenager’ or ‘20’ or ‘30’ or ‘40’ or ‘50’ or ‘60’ or ‘70’
string	dp_search_race	Optional. People race [ ‘asian’ or ‘brazilian’ or ‘black’ or ‘caucasian’ or ‘hispanic’ or ‘middle’ or ‘multi’ or ‘native’ or ‘other’ ]
int	dp_search_quantity	Optional. People quantity in the image. Means ‘any’ if greater than 3. [ 1 or 2 or 3 ]
string	dp_item_permission	Optional. Search some special type of files. “regular” - All files (default) or “enterprise” - Curated Collection or “premium” - Focused Collection
bool	dp_search_audio	Optional. Default is false. If true, the search results include audio of both kinds, music and sound effects.
bool	dp_search_music	Optional. If true, the search results include audio, narrowed to music.
bool	dp_search_sound_effect	Optional. If true, the search results include audio, narrowed to sound effects.
string	dp_search_audio_type	Optional. ‘music’ or ‘sound_effect’. An equivalent of the two parameters above: it both includes audio and narrows it to that kind.
int	dp_search_resolution	Optional. Minimum video resolution. 0 - all (default), 1 - 720p, 2 - 1080p, 3 - 4K. Conditional, see the note below the table.
number	dp_search_length_start	Optional. Minimum length in seconds, for video and audio. Fractional values are accepted.
number	dp_search_length_end	Optional. Maximum length in seconds, for video and audio. Fractional values are accepted.
bool	dp_search_slow_motion	Optional. Pass true to restrict the results to slow motion videos. Omit it for no restriction.
bool	dp_search_time_lapse	Optional. Pass true to restrict the results to time lapse videos. Omit it for no restriction.
int\|arr	dp_search_genre	Optional. Music genre id, or an array of ids, from dp_command=audio.genres.getList
int\|arr	dp_search_mood	Optional. Mood id, or an array of ids, from dp_command=audio.moods.getList
int\|arr	dp_search_instrument	Optional. Instrument id, or an array of ids, from dp_command=audio.instruments.getList
int\|arr	dp_search_sfx_type	Optional. Sound effect type id, or an array of ids, from dp_command=audio.soundEffects.getList
int	dp_search_bpm_start	Optional. Minimum tempo in beats per minute.
int	dp_search_bpm_end	Optional. Maximum tempo in beats per minute.

Video and audio filters are conditional:

the audio filters dp_search_genre, dp_search_mood, dp_search_instrument, dp_search_sfx_type, dp_search_bpm_start and dp_search_bpm_end are applied only when the search includes audio. Any one of dp_search_audio, dp_search_music, dp_search_sound_effect and dp_search_audio_type puts it there, so none of them is a prerequisite for the others;
dp_search_length_start and dp_search_length_end are applied only when dp_search_audio or dp_search_video is true;
dp_search_resolution is applied only on a search that includes video and excludes both images and vectors. Because dp_search_photo and dp_search_vector default to true, that means sending dp_search_video=true together with dp_search_photo=false and dp_search_vector=false;
dp_search_width, dp_search_height, dp_search_max_width and dp_search_max_height are the mirror image of that rule: they are applied only on a search that does not include video, and are ignored entirely once it does.

List of colors:

0	any
1	blue	#00007c
2	blue	#0005fd
3	blue	#01ffff
4	green	#027f00
5	green	#04fe00
6	yellow	#ffff00
7	orange	#f9be00
8	orange	#fecd9b
9	red	#fe0000
10	red	#7e0004
11	brown	#653201
12	violet	#ff01ff
13	violet	#810081
14	grey	#bfbfbf
15	grey	#7a7a7a
16	black	#000000
17	white	#ffffff

List of languages:

en - English

de - Deutsch

fr - Français

sp - Español

ru - Русский

it - Italiano

pt - Português

es - Español

pl - Polski

nl - Nederlands

jp - 日本語

cz - Česky

se - Svenska

zh - 中文

tr - Türkçe

mx - Español (Mexico)

gr - Ελληνικά

ko - 한국어

br - Português (Brasil)

hu - Magyar

uk - Українська

ro - Română

id - Bahasa Indonesia

th - ไทย

Response

{
    "timestamp": "2013-03-12 11:12:54",
    "version": "1.3",
    "result" :[
    {
        "id": 3366293,
        "thumbnail": "http://static4.depo...office-desk.jpg",
        "medium_thumbnail": " http://static...positphotos_1786993-Cat.jpg
        "url": "http://s...office-desk.jpg",
        "url2": "http://s...api_thumb_450.jpg",
        "url_big": "http://s...ice-desk.jpg",
        "url_max_qa": "http://s...ice-desk.jpg",
        "itemurl": "http://depositphotos.com/...office-desk.html",
        "mp4": "http://s...../depositphotos_1232343-item-title.mp4
        "webm": "http://s...../depositphotos_1232343-item-title.webm
        "published": "Jan.25, 2010 12:31:33",
        "updated": "Jan.24, 2010 02:12:29",
        "itype": "image",
        "iseditorial": false,
        "title": "Pretty Caucasian business woman at office desk",
        "description": "Pretty Caucasian ... in the back",
        "userid": 1011061,
        "username": "Alexxx"
        "avatar": "",
        "status": "active"
        "itype": "image",
        "width": 6048,
        "height": 4032,
        "mp": 24.385536,
        "original_filesize": 2643198,
        "original_extension": "jpg",
        "exclusive": "no",
        "editorial": "no",
        "deposit_item_id": 3366293
        "views": 91
        "downloads": 3
        "level": "beginner"
        "similar": [
             1034007,
             1235904,
             ....
        ],
        "series" : [
             1803161,
             ....
        ]
        "same_model" : [
             ....
        ]
    },
    ....
    ],
    "count":13009933,
    "hash": 1z4ep6,
    "type": "success"
}

getMediaData 

Retrieve all information about the media item.

Request

string	dp_command	Command name ‘getMediaData’
string	dp_apikey	Client API key
int \| array	dp_media_id	ID of requested item. Can be integer (for single item) or array for several.
bool	dp_full_similar	Optional. Default is false. If false, search returns array of ID similar, series. If true, search returns array of objects {id: similar_id, thumbnail: link on similar thumbnail}.
string	dp_domain	Optional. Default is ‘depositphotos.com’. Domain name of any available CDN server (e.g. imgcontent.net).
string	dp_datetime_format	Optional. Default is ‘datetime’. Determines output format for date. Values: ‘date’, ‘datetime’, ‘unix’. ‘date’ => ‘Apr. 18, 2019’ ‘datetime’ => ‘Apr. 18, 2019 14:54:25’ ‘unix’ => ‘1408443174’ (Seconds since Unix Epoch)
bool	dp_translate_items	Optional. Default is false. If true, title, description, categories will be translated (if translation exists) to language dp_lang. Tags will be translated if only single item is requested.
string	dp_country_excluded	Optional. Apply country restrictions. For example, with dp_country_excluded=cn items forbidden in China will not be returned. Values match the Available languages abbrev.
string	dp_lang	Optional. Language for translation (‘de’, ‘ru’, ‘fr’, ‘sp’, ‘zh’ (for chinese) etc.)
int	dp_search_layout	Optional. Default is 0. If 1, results returned in same format as search.

Response

{
    "timestamp": "2020-03-13 06:49:19",  // Current date and time in YYYY-MM-DD HH:MI:SS format
    "version": "1.3",                    // API version
    "type": "success",                   // The query result type
    "title": "Gorgeous brunette woman.", // Item title
    "description": "Portrait of elegantly dressed young gorgeous brunette woman.",  // Item description
    "width": "2584",                     // Width of the original media
    "height": "3000",                    // Height of the original media
    "mp": "7.75",                        // Original resolution in megapixels
    "status": "active",
    "views": 17225,                      // Number of views for current item
    "downloads": 1269,                   // Number of downloads for current item
    "categories": {                      // Categories the current item available in
        "10": "Beauty & Fashion",        // Result format is {category_id: category_name}
        "29": "People"
    },
    "published": "Jan.31, 2013 15:29:17",  // Datetime of item publication
    "username": "envivo",                // Author of current item
    "level": "silver",                   // Current image author level
    "sizes": {                           // Array of sizes available for current item
        "s": {
            "width": 431,
            "height": 500,
            "credits": 1,                // Media price with discount
            "subscription": 1,           // Available by subscription
            "imagepack": 0,              // Available by imagepack
            "ondemand": 1,
            "mp": 0.5
        },
        "m": {
            "width": 861,
            "height": 1000,
            "credits": 3,
            "subscription": 1,
            "imagepack": 0,
            "ondemand": 1,
            "mp": 2
        },
        "l": {
            "width": 1723,
            "height": 2000,
            "credits": 6,
            "subscription": 1,
            "imagepack": 0,
            "ondemand": 1,
            "mp": 8
        },
        "xl": {
            "width": 2584,
            "height": 3000,
            "credits": 10,
            "subscription": 1,
            "imagepack": 0,
            "ondemand": 1,
            "mp": 15
        },
        "el0": {
            "width": 2584,
            "height": 3000,
            "credits": 80,
            "subscription": 0,
            "imagepack": 0,
            "ondemand": 1
        }
    },
    "upload_timestamp": "1359471261",
    "id": "19478735",                    // Item ID
    "userid": 1345889,                   // Item author ID
    "user_id": 1345889,
    "blocked": false,
    "updated": "Jul.08, 2019 13:11:49",
    "isextended": true,                  // If false, the item cannot be sold with an extended license
    "isexclusive": false,                // Whether item is exclusive
    "nudity": false,
    "iseditorial": false,                // Whether item can be sold only for editorial use
    "is_editorial": "no",
    "isFreeItem": false,
    "is_mobile": "no",
    "itype": "image",                    // Media type (image, vector, video)
    "original_filesize": "3675812",      // File size of original file in bytes
    "original_extension": "jpg",         // Extension of original file
    "thumbnail": "https://st.depositphotos.com/.../thumb_110.jpg",
    "thumb": "https://st.depositphotos.com/.../thumb_110.jpg",       // Link to small item preview
    "thumb_large": "https://st.depositphotos.com/.../thumb_170.jpg",
    "thumb_huge": "https://st.depositphotos.com/.../thumb_450.jpg",  // Link to huge item preview
    "thumb_max": "https://st.depositphotos.com/.../woman.jpg",
    "medium_thumbnail": "https://st.depositphotos.com/.../thumb_170.jpg",  // Link to medium item preview
    "large_thumb": "https://st.depositphotos.com/.../woman.jpg",     // Link to large item preview
    "url_big": "https://st.depositphotos.com/.../woman.jpg",
    "url_max_qa": "https://st.depositphotos.com/.../thumb_450.jpg",
    "thumb_170": "https://st.depositphotos.com/.../woman.jpg",
    "huge_thumb": "https://st.depositphotos.com/.../woman.jpg",
    "url": "https://st.depositphotos.com/.../thumb_110.jpg",         // Link to big item preview with Depositphotos watermark
    "url2": "https://st.depositphotos.com/.../thumb_450.jpg",        // Link to big item preview with neutral watermark
    "itemurl": "https://depositphotos.com/.../woman.html",           // Link to item on Depositphotos
    "lightfield": false,
    "avatar": "https://st.depositphotos.com/.../avatar.jpg",         // Author photo link
    "tags": [                            // Array of tags associated with media
        "fun",
        "blue",
        "beautiful",
        "happy",
        "business",
        "person",
        "girl",
        "female",
        "young",
        "smiling",
        "people",
        "women",
        "cheerful",
        "portrait",
        "cute",
        "smile",
        "brunette",
        "pretty",
        "woman",
        "attractive",
        "gorgeous"
    ],
    "available_sizes": {                 // Array of sizes available for current item
        "s": 1,                          // Result format is {size_name: item_price_in_credits}
        "m": 3,
        "l": 6,
        "xl": 10,
        "el0": 80
    },
    "similar": [                         // Similar items IDs
        157798924,
        117883264,
        173483706,
        133222882
    ],
    "same_model": [                      // Same model items IDs
        20192481,
        18186253,
        24131271,
        19374401
    ],
    "series": [                          // Same series items IDs
        14784249,
        20192371,
        20192481,
        21262963
    ]
}

Audio taxonomies 

Audio search is filtered by ids, not by names. These four methods return the id lists used by dp_search_genre, dp_search_mood, dp_search_instrument and dp_search_sfx_type. All four take the same single parameter and answer in the same shape.

audio.genres.getList 

Returns all music genres with their ids.

Request

string	dp_command	Command name ‘audio.genres.getList’
string	dp_apikey	API key

Response

{
    "timestamp": "2020-03-13 06:49:19",
    "version": "1.3",
    "type": "success",
    "result": true,
    "data": [
        {"id": 2, "name": "Alternative & Punk", "alias": "alternative-and-punk"},
        {"id": 4, "name": "Ambient", "alias": "ambient"},
        {"id": 6, "name": "Kids", "alias": "kids"}
    ]
}

audio.moods.getList 

Returns all music moods with their ids. Same request shape as audio.genres.getList; the objects in data carry id and name.

Response

{
    "timestamp": "2020-03-13 06:49:19",
    "version": "1.3",
    "type": "success",
    "result": true,
    "data": [
        {"id": 2, "name": "Angry"},
        {"id": 4, "name": "Bright"},
        {"id": 6, "name": "Calm"}
    ]
}

audio.instruments.getList 

Returns all instruments with their ids. Same request shape as audio.genres.getList; the objects in data carry id and name.

Response

{
    "timestamp": "2020-03-13 06:49:19",
    "version": "1.3",
    "type": "success",
    "result": true,
    "data": [
        {"id": 2, "name": "Brass"},
        {"id": 4, "name": "Guitar"},
        {"id": 6, "name": "Bass"}
    ]
}

audio.soundEffects.getList 

Returns all sound effect types with their ids. Same request shape as audio.genres.getList; the objects in data carry id, name and alias.

Response

{
    "timestamp": "2020-03-13 06:49:19",
    "version": "1.3",
    "type": "success",
    "result": true,
    "data": [
        {"id": 4, "name": "Ambience", "alias": "ambience"},
        {"id": 6, "name": "Animal", "alias": "animal"},
        {"id": 8, "name": "Cartoon Sound Effect", "alias": "cartoon"}
    ]
}

Complimentary downloads 

All corporate users of Enterprise API can download high-resolution test samples without watermarks (unless special downloading rights are set.)

complimentaryDownload 

Returns a link to a file for free download

Request

string	dp_command	Command name ‘complimentaryDownload’
string	dp_apikey	API key
string	dp_session_id	Session ID
int	dp_item_id	The identifier of the item
string	dp_option	The size of file. Not required for audio items

dp_option names the size you want. A complimentary download licenses nothing and is not checked against any license; for licenseItem, take the id from the sizes of the license you chose in getLicenseOfGroup. Each license offers its own subset of the shared vocabulary:

images and vectors, Social Media / Publishing / Digital / Enterprise License: s-2015, m-2015, l-2015, xl-2015, vect, ds
images and vectors, Focused (premium) collection: cs, cl for the Standard License, xl-2015 for the Enhanced License
video, Media / Publishing / Digital / Enterprise License: smallweb (SD 240p), bigweb (SD 480p), hd720 (HD 720p), hd1080 (HD 1080p), 4k (4K)
audio: audio for the Standard Audio License, audio-el for the Extended one
AI generated images: s-2015, m-2015, l-2015, xl-2015, ds

The two Focused-collection licenses reach getLicenseOfGroup only for a group on the premium license model with the Premium collection enabled; xl-2015 stays available through the standard set regardless.

Response

{
     "timestamp": "2013-03-13 06:49:19"
     "version": "1.3",
     "type": "success"
     "apiKey": "0cbc785ec3776c276bf2f"
     "downloadLink": "http://st.depositphotos.com/storage/item/download?id=1234"
}

To view information on free downloads over a selected period, the following method is used:

getGroupCompDownloads 

Returns all free downloads for a current group.

Request

string	dp_command	Command name ‘getGroupCompDownloads’
string	dp_apikey	API key
string	dp_session_id	Session ID
int	dp_date_start	Start date when items were downloaded
string	dp_date_end	End date when items were downloaded
string	dp_user_id	Id of user downloaded item
int	dp_limit	The number of downloads
int	dp_offset	The shift from the beginning
string\|array	dp_type	image/vector/video

Response

{
     "timestamp": "2013-05-06 09:30:50"
     "version": "1.3"
     "type": "success"
     "downloads": [
         {
              "datetime": 1471871234
              "filename": "File name here"
              "groupId": 12
              "itemId": 12345678
              "marker": 3
              "itemType": "video"
              "itemLink": "/123/link.html"
              "preview": "http://st.depositphotos.com/123/linktofile/filename.jpg"
              "width": 1920
              "height": 1080
              "userId": 12345678
              "actor": [
                  "id": 12345678
                  "username": "Usertest"
              ]
              "seler": [
                  "id": 12345678
                  "username": "Usertest"
              ]
              "download": "http://st.depositphotos.com/storage/item/download?id=1234"
              "visible": true
         }
         {
             ...
         }
     ]
     "count": 2
}

AI Image Generator 

The API provides endpoints that allow users to generate and retrieve images. All images created using the Depositphotos AI Image Generator can be licensed like any other file on Depositphotos through the licenseItem command.

To integrate the AI Image Generator into your product and start generating images, select an API plan that meets your image generation needs.

Key API Endpoints and Functionalities:

imageGenerator.generate 

Initiates the image generation process based on the input request. If a callback address is provided in the request, the generated image will be sent there. Otherwise, users can retrieve the result using the imageGenerator.get command.

Request

string	dp_command	Command name ‘imageGenerator.generate’
string	dp_apikey	API key
string	dp_session_id	Session ID
string	dp_prompt	The prompt for image generation. Maximum length is 400
string	dp_callback_url	Optional. Callback URL where the results will be sent
string	dp_aspect_ratio	Optional. The aspect ratio of the image [“1:1”\|”2:3”\|”3:2”\|”3:4”\|”4:3”\|”4:5”\|”5:4”\|”9:16”\|”16:9”]
string	dp_medium	Optional. Medium of the generated images. [“art”\|”photography”]

Response

{
    "timestamp": "2024-09-24 12:27:04",
    "version": "1.3",
    "type": "success",
    "data": {
        "uuid": "3524139b-20c7-4cda-8860-8ede3f79306d",
        "prompt": "Entered prompt",
        "status": "new",
        "purchaseStatus": "deferred",
        "items": [
            {
                "uuid": "328f2aa8-6e7f-4c65-8761-91f9110e80c0",
                "dpItemId": null,
                "previewUrl": null
            },
            {
                "uuid": "b9cd71f9-89c1-4311-929d-211d567a9352",
                "dpItemId": null,
                "previewUrl": null
            },
            {
                "uuid": "610811f8-ab8c-4a08-a284-885d5675b449",
                "dpItemId": null,
                "previewUrl": null
            },
            {
                "uuid": "e1410eb7-3279-4962-8a04-1bbda618919c",
                "dpItemId": null,
                "previewUrl": null
            }
        ]
    }
}

imageGenerator.get 

Retrieves the status and details of a generated image using its unique prompt UUID. If successful, the data will show

data["status"]: "completed"
data["purchaseStatus"]: "paid"
data["items"][]["dpItemId"]: not null

The command response may change during processing. In the first step of processing, it will contain the value of the previewUrl field and will not contain the dpItemId. Later, the dpItemId value will appear.

You can preview the generated image via the previewUrl field and license it using the dpItemId

It is important to note that the content at the previewUrl link will only be temporarily available.

For licensing, simply use the licenseItem command.

Request

string	dp_command	Command name ‘imageGenerator.get’
string	dp_apikey	API key
string	dp_session_id	Session ID
string	dp_uuid	Prompt uuid received from imageGenerator.generate

Response

{
    "timestamp": "2024-09-24 12:29:04",
    "version": "1.3",
    "type": "success",
    "data": {
        "uuid": "3524139b-20c7-4cda-8860-8ede3f79306d",
        "prompt": "Entered prompt",
        "status": "completed",
        "purchaseStatus": "paid",
        "items": [
            {
                "uuid": "328f2aa8-6e7f-4c65-8761-91f9110e80c0",
                "dpItemId": 123456781,
                "previewUrl": "https://st5.depositphotos.com/secure/234567/123456781/staff_1024.jpg?md5=90dddd3a1e0fa045badd591af255b60c"
            },
            {
                "uuid": "b9cd71f9-89c1-4311-929d-211d567a9352",
                "dpItemId": 123456782,
                "previewUrl": "https://st5.depositphotos.com/secure/234567/123456782/staff_1024.jpg?md5=0919446ec73f95992aa1417e591dc186"
            },
            {
                "uuid": "610811f8-ab8c-4a08-a284-885d5675b449",
                "dpItemId": 123456783,
                "previewUrl": "https://st5.depositphotos.com/secure/234567/123456783/staff_1024.jpg?md5=6dbf4e6f0f8cc0292254fcbc0a1113af"
            },
            {
                "uuid": "ce735bf2-9c19-492a-816c-19a63833ceaf",
                "dpItemId": 123456784,
                "previewUrl": "https://st5.depositphotos.com/secure/234567/123456784/staff_1024.jpg?md5=fef0e146e16663aa72023d36ec33bd64"
            }
        ]
    }
}

imageGenerator.getMediaData 

After the entire generation process is completed, the command allows you to get the data of each generated item separately using its uuid.

Request

string	dp_command	Command name ‘imageGenerator.getMediaData’
string	dp_apikey	API key
string	dp_session_id	Session ID
string	dp_uuid	Generated file uuid: imageGenerator.generate `data["items"][]["uuid"]`. The prompt uuid `data["uuid"]` belongs to imageGenerator.get.

Response

{
    "timestamp": "2024-09-24 12:29:34",
    "version": "1.3",
    "type": "success",
    "data": {
        "id": 123456781,
        "height": 2048,
        "width": 2048,
        "type": "i",
        "aiGenerated": true,
        ....
    }
}

Licensing of files 

Licensing of files is the process when a client informs that the file suits him/her and then he/she pays for it. Files purchase is performed using account balance or on credit in case of “Postpaid” payment. Licensing is performed under one of the licenses previously configured for the account. Each license has its own price. To license the file, you have to know the list of available licenses for the group and to determine the license, which will be used for licensing of the file.

getLicenseOfGroup 

Returns a list of licenses available to the group of users.

Request

string	dp_command	Command name ‘getLicenseOfGroup’
string	dp_apikey	API key
string	dp_session_id	Session ID

Response

{
     "timestamp": "2013-03-13 06:49:19",
     "version": "1.3",
     "type": "success"
     "data": {
      [
         "licenseId": 12345
         "licenseName": "Digital License"
         "templateId": 12
         "productType": "image"
         "sizes": {
          [
             "id": "s-2015"
             "label": "Small"
             "price": 12.34
          ],
          [
             ...
          ]
         }
      ],
      [
         ...
      ],
     }
     "count": 2
}

licenseItem 

Obtaining a license to use a file

Request

string	dp_command	Command name ‘licenseItem’
string	dp_apikey	API key
string	dp_session_id	Session ID
array	dp_licensing	Licensing data
string	dp_project	Optional. Default ‘’
string	dp_client	Optional. Default ‘’
string	dp_purchase_order	Optional. Default ‘’
string	dp_isbn	Optional. Default ‘’
string	dp_other	Optional. Default ‘’

Parameters dp_project, dp_client, dp_purchase_order, dp_isbn, dp_other are non-mandatory. These parameters are set up by the manager and are used for convenience. dp_licensing parameter must contain an object with the following data, or an array of such objects to license several files in one call:

{
    "dp_item_id": 12345678,
    "dp_license_id": 10123,
    "dp_option": "s-2015",
    "dp_ext_options": 27
}

dp_license_id is a license id from getLicenseOfGroup, and dp_option is one of the size ids that method returns for that license. The size vocabulary is listed in full under complimentaryDownload.

dp_item_id accepts a single id or an array of ids, so one object in dp_licensing can cover several files that share the same license and size.

A batch can partially succeed. By default a file that cannot be licensed does not fail the call: the response still carries status: success, and each entry of result is keyed by item id and holds either result: "success" with its transactions and downloadLink, or result: "error" with errors carrying error_message and error_code. Inspect every entry rather than the overall status. Pass the optional dp_strict (bool, default false) to get the opposite behaviour: one bad file then fails the whole request with an error code and nothing is licensed.

dp_ext_options parameter contains integer with a bit mask for additional options:

1	Unlimited print
2	Multi-seat
4	Extra legal warranty
8	Product for resale and free distribution
16	Transfer rights

Response

{
     "timestamp": "2013-03-13 06:49:19",
     "version": "1.3",
     "type": "success"
     "status": "success"
     "result": [
         "12345678" : [
             "result": "success"
             "transactions": [
                 "12345678" : {
                     [
                         "sizes": 2
                         "license": 10123
                         "transactionId": 1234567
                     ],
                     [
                         ...
                     ]
                 ]
             }
             "transaction": {
                 [
                     "sizes": 2
                     "license": 10123
                     "transactionId": 12345678
                 ],
                 [
                     ...
                 ]
             }
             "fileId": 12345678
             "downloadLink": "http://st.depositphotos.com/storage/item/download?id=1234"
         ]
     ]
}

getLicensedItems 

This method returns a list of user’s licensed files

Request

string	dp_command	Command name ‘getLicensedItems’
string	dp_apikey	API key
string	dp_session_id	Session key
string	dp_type	Optional. Type of licenses. [“paid”\|”uninvoiced”\| “uninvoicedAll”\|”invoiced”\|”paidUninvoiced”\|”paidInvoiced”]. Default - all types
str\|arr	dp_item_type	Optional. Type of licensed item, or an array of types: “image”, “vector”, “video”, “audio”. Default - all item types
string	dp_date_start	Optional. Start date when items were licensed
string	dp_date_end	Optional. End date when items were licensed
int	dp_user_id	Optional. User identity filter
int	dp_offset	Optional. Shift for page
int	dp_limit	Optional. Limit for display invoices per page

dp_type filters on two independent things at once, whether the transaction is paid and whether it has been invoiced:

paid - paid, invoiced or not
uninvoiced - unpaid and not invoiced
uninvoicedAll - not invoiced, paid or not
invoiced - unpaid and invoiced
paidUninvoiced - paid and not invoiced
paidInvoiced - paid and invoiced

Omit it to get every state.

Response

{
     "timestamp": "2013-05-06 09:30:50"
     "version": "1.3"
     "type": "success"
     "downloads": {
      [
         "itemTransactionId": 123456789
         "licenseId": 10123
         "datetime": 1471871234
         "filename": "Some filename here"
         "itemId": 1234567
         "itemLink": "http://depositphotos.com/01234/item-name.html"
         "preview": "http://static5.depositphotos.com/.../depositphotos_01234-item-name.jpg"
         "width": 110
         "height": 110
         "userId": 12345678
         "actor": [
             "id": 12345678
             "username": "Username"
         ],
         "seller": [
             "id": 12345678
             "username": "Username"
         ]
         "licenseTransferId": 1234567
         "status": "Invoiced"
         "purchaseOrder": "Some order"
         "invoice_id": 12345
         "marker": 3
         "currencyId": 5
         "groupId": 1234
         "visible": true
      ],
      [
         ...
      ]
     }
     "count": 2
}

getTransactionLicenseInfo 

The method returns information on the license issued on a file

Request

string	dp_command	Command name ‘getTransactionLicenseInfo’
string	dp_apikey	API key
string	dp_session_id	Session key
int	dp_transaction_id	Identity of licenses transaction

Response

{
  "timestamp": "2013-03-25 10:10:06",
  "version": "1.3",
  "type":"success",
  "license" => [
      "id" => 12
      "name" => "Test"
      "link" => "/license-desc.html"
      "fields" => []
      "transferId" => 12|null
  ],
  "transaction" => [
      "id" => 12
      "price" => 12.99
      "size" => "xs|s|m|l|xl|xxl|vect|.."
      "timestamp" => 1234567890
      "currencyId" => 5
  ],
  "item" => [
      "id" => 12
      "filename" => "test.jpg"
      "type" => "image|vector|video"
      "isEditorial" => true|false
      "isNudity" => true|false
      "preview" => "http://static6.depositphotos.com/..."
      "link" => "http://test"
      "width" => 1080
      "height" => 1920
  ],
  "from": [
      "company": "Depositphotos Inc."
      "address": "547 Broadway, ..."
      "someAnotherKey": anotherValue
      ... : ...
  ]
  "to": [
      "company": "Some user company"
      "address": "Company address here"
      "someAnotherKey": anotherValue
      ... : ...
  ]
  "transferredTo": [
      "company": "Some user company"
      "address": "Company address here"
      "someAnotherKey": anotherValue
      ... : ...
  ]
}

Transfer of license 

Transfer of license allows transferring rights to use the content to the third party

transferEnterpriseLicense 

Transfers license from current user to another user

Request

str	dp_command	Command name ‘transferEnterpriseLicense’
str	dp_apikey	API key
str	dp_session_id	Session key
int	dp_item_transaction_id	Transaction id. Optional
array	dp_item_transaction_ids	Transaction ids. Optional.
array	dp_from	From data.
array	dp_to	To data

One of dp_item_transaction_id or dp_item_transaction_ids should be passed. dp_from and dp_to data should be object, that can contain following keys:

{
    "company":...,
    "fullName":...,
    "address":...,
    "city":...,
    "state":...,
    "zip":...,
    "email":...,
    "phone":...,
    "country":...,
    "website":...
}

Response

{
     "timestamp": "2013-05-06 09:30:50"
     "version": "1.3"
     "type": "success"
     "result": true|false
}

getTransferredLicenses 

Returns transferred licenses for the current user group

Request

string	dp_command	Command name ‘getTransferredLicenses’
string	dp_apikey	API key
string	dp_session_id	Session key
int	dp_offset	Shift for page
int	dp_limit	Limit for display invoices per page
string	dp_date_start	Optional. Start date when items were licensed
string	dp_date_end	Optional. End date when items were licensed
int	dp_user_id	Optional. User identity filter
string	dp_type	Optional. Type of licenses. Can be “paid”, “uninvoiced”, “uninvoicedAll”, “invoiced”, “paidUninvoiced” or “paidInvoiced”. Default - all types
str\|arr	dp_item_type	Optional. Type of licensed item, or an array of types: “image”, “vector”, “video”, “audio”. Default - all item types

dp_type takes the same six values as getLicensedItems, with the same meanings.

Response

{
     "timestamp": "2013-05-06 09:30:50"
     "version": "1.3"
     "type": "success"
     "downloads": {
      [
         itemTransactionId: 123456789
         licenseId: 10123
         datetime: 1471871234
         filename: "Some filename here"
         itemId: 1234567
         itemLink: "http://depositphotos.com/01234/item-name.html"
         preview: "http://static5.depositphotos.com/.../depositphotos_01234-item-name.jpg"
         width: 110
         height: 110
         userId: 12345678
         actor: [
             id: 12345678
             username: "Username"
         ],
         seller: [
             id: 12345678
             username: "Username"
         ]
         licenseTransferId: 1234567
         status: "Invoiced"
         purchaseOrder: "Some order"
         marker: 3
         currencyId: 5
         groupId: 1234
         visible: true
      ],
      [
         ...
      ]
     }
     count: 2
}

Working with invoices 

createEnterpriseInvoice 

Creates an invoice for licenses created by the group

Request

string	dp_command	Command name ‘createEnterpriseInvoice’
string	dp_apikey	API key
string	dp_session_id	Session key
array	dp_item_transaction_ids	Transaction Ids to include into the invoice as array. For example: {12345677, 12345678, 123456789}
string	dp_field_value	Optional. Value of invoiced field to replace in the invoice

Response

{
     "timestamp": "2013-03-13 06:49:19",
     "version": "1.3",
     "type": "success"
     "result": true|false
}

getEnterpriseInvoice 

Returns detailed information on the invoice

Request

string	dp_command	Command name ‘getEnterpriseInvoice’
string	dp_apikey	API key
string	dp_session_id	Session key
int	dp_invoice_id	Invoice id for detail

Response

{
     "timestamp": "2013-03-13 06:49:19",
     "version": "1.3",
     "type": "success"
     "invoice": [
         "items" : {
          [
             "description": "Balance Refill"
             "qty": 123
             "price": 123
          ]
          [
             "itemId": 12345678
             "thumbUrl": "http://static5.depositphotos.com/../depositphotos_itemname.jpg"
             "licenseInfo": {
              [
                 "key": "Project",
                 "value": "Some project here"
              ],
              [
                 "key": "Purchase Order",
                 "value": "Some order here"
              ],
              [
                 ...
              ]
             }
             "licenseId": 10123
             "size": "s-2015"
             "itemOriginalSize": [
                 "height": 1050
                 "width": 1980
             ]
             "type": "image"
             "price": 123.45
             "vatPrice": 134
             "vatRate": 10.00
             "isEditorial": false
             "isNudity": false
          ],
          [
             ...
          ]
         }
         "state": "paid"
         "total": 456.78
         "vat": 11.11
         "subTotal": 445.67
         "id": 987654
         "number": "ESI-10987654"
         "type": "file_invoice"
         "date": 1471871234
         "currencyId": 0
         "from": [
             "company": "Depositphotos Inc."
             "address": "547 Broadway, ..."
             "someAnotherKey": anotherValue
             ... : ...
         ]
         "to": [
             "company": "Some user company"
             "address": "Company address here"
             "someAnotherKey": anotherValue
             ... : ...
         ]
         "paid": 1471871234
     ]
}

getEnterpriseInvoiceCount 

Returns number of invoices issued to the group

Request

string	dp_command	Command name ‘getEnterpriseInvoiceCount’
string	dp_apikey	API key
string	dp_session_id	Session key
string	dp_state	Optional. Invoice state. “unpaid” or “paid” or”cancelled” Default - all
int	dp_group_id	Optional. Group id to filter

Response

{
     "timestamp": "2013-03-13 06:49:19",
     "version": "1.3",
     "type": "success",
     "count": 2
}

getEnterpriseInvoiceList 

Lists invoices of the group

Request

string	dp_command	Command name ‘getEnterpriseInvoiceList’
string	dp_apikey	API key
string	dp_session_id	Session key
int	dp_offset	Shift for page
int	dp_limit	Limit for display invoices per page
string	dp_state	Optional. Invoice state. “unpaid” or “paid” or”cancelled” Default - all

Response

{
     "timestamp": "2013-03-13 06:49:19",
     "version": "1.3",
     "type": "success"
     "count": 2
     "data": {
      [
         "id": 987654
         "date": 1471871234
         "description": "Invoice description here"
         "number": "ESI-10987654"
         "type": "file_invoice"
         "price": 123.45
         "amount": 123.45
         "paymentDate": 1471871234
         "currencyId": 5
      ],
      [
         ...
      ]
     }
}