{ "info": { "_postman_id": "9a5950f0-c20d-444e-90c7-e27b9766d394", "name": "API Suite API", "description": "## Introduction to the Creative Suite API\n\nThe Creative Suite API offers powerful integration capabilities, providing seamless access to millions of high-quality images, videos, vectors, and music. With built-in AI tools, businesses and developers can enhance their applications, workflows, and marketing campaigns with world-class visual content, making it an ideal solution for efficient content management.\n\n### Main features of Creative Suite API\n\nThe modular, all-in-one Creative Suite API combines a vast stock content library, professionally created templates, and AI-powered tools to automate repetitive tasks. This unified solution saves time for creativity while allowing API partners to enjoy a bespoke pricing model, paying only for the features they need.\n\n\nThe Creative Suite API includes:\n\n- **Stock Content Library.** Access millions of photos, videos, and vectors programmatically.\n\n- **Background Remover.** Efficiently remove backgrounds from images and videos, and streamline editing workflows.\n\n- **AI Image Generator.** Enable the creation of unique, AI-generated visuals directly within your platform, offering a powerful tool for producing custom content.\n\n- **AI tools.** Automate edits such as image upscaling and object replacement.\n\n- **VistaCreate editor**. Easily create and customize designs directly within your app.\n\n\nThe Creative Suite API simplifies visual content management by providing instant retrieval of licensed images, videos, and more, automating content organization and handling, and offering scalable creative solutions tailored for digital platforms and campaigns.\n\n\nBy streamlining tools and reducing complexity, the Creative Suite API optimizes workflows and enhances creative production.\n\n### Overcoming challenges with the Creative Suite API\n\n- **Manual inefficiencies.** Eliminates repetitive tasks like content downloads and uploads.\n\n- **Time constraints.** Speeds up workflows by integrating content search directly into your system.\n\n- **Customization gaps.** Tailored for specific needs, including e-commerce, design software, or marketing tools.\n\n### Target audience\n\nThe Creative Suite API is designed for:\n\n- **Developers:** Integrating creative assets into apps and platforms.\n\n- **E-commerce:** Enriching platforms with high-quality images and videos.\n\n- **Marketing teams:** Automating content management for campaigns.\n\n- **Creative agencies:** Enhancing design tools and workflows.\n\n### Use cases\n\nCreative Suite API can be used for:\n\n- **E-commerce.** Automatically populate product listings with relevant visuals.\n\n- **CMS.** Enable direct image and video search and embedding.\n\n- **Creative tools.** Integrate Depositphotos assets into design or video editing software.\n\n### Getting started\n\nTo begin using the Creative Suite API:\n\n1. **Visit** the [Creative Suite API page](https://depositphotos.com/api-suite.html) and fill out the form.\n\n2. **Contact the API Manager:** Discuss the functionality you plan to use with the API.\n\n3. **Test the API:** The API manager creates a sandbox account and sends you an API key for testing.\n\n4. **Check** [Api General Principles](https://create.vista.com/suite-api/doc/api-general-principles)\n\n5. **Discuss the pricing model:** A pricing model will be shared based on your usage.\n\n6. **Sign the contract:** Review and sign a contract that includes all terms and conditions.\n\n7. **Payment:** Payment is received from the client.\n\n8. **Receive API Key:** The API manager creates the production account and provides an API key for full access.\n\n9. **Receive Credentials:** to use in the [Login command](https://create.vista.com/suite-api/doc/api-reference/login)\n\n\n### General Principles for Working with the API\nAll API calls are performed via the HTTPS protocol using the GET or POST parameters. The API returns a response in JSON format, always with an HTTP status code of 200, containing execution status or an error description.\n\n#### Base URL\nAll requests must be sent to the following base URL:\n\n```\nhttps://api.depositphotos.com\n```\n\n#### Mandatory Parameters\nEach API request requires the following mandatory parameters:\n\n- `dp_apikey`: Your unique API key issued upon registration [Creative Suite API page](https://depositphotos.com/api-suite.html).\n- `dp_command`: The specific API method (command) you want to execute. List of available commands can be found in the **API Reference** section.\n\nFor methods requiring user authorization, an additional mandatory parameter is required:\n\n- `dp_session_id`: A unique session ID, which will be provided in the response after [**logging in**](https://create.vista.com/suite-api/doc/api-reference/login).\n\nFor requests, you can use either form-data or JSON format for all variables. If you want to use JSON format, you should:\n- Set the `Content-Type` header to `application/json`.\n- Pass the `dp_command` parameters in the URL (e.g., `https://api.depositphotos.com?dp_command=login`).\n- Pass the `dp_apikey` parameter and other required parameters in the requestBody (e.g., `{\"dp_apikey\": \"123\"}`).\n\n#### Example of a request in JSON format:\n\n```bash\ncurl --silent 'https://api.depositphotos.com/?dp_command=imageGenerator.generate' \\\n-H 'Content-Type: application/json' \\\n-H 'Accept: application/json' \\\n -d '{\n\"dp_apikey\": \"INSERT_YOUR_API_KEY_HERE\",\n\"dp_session_id\": \"INSERT_YOUR_AUTH_SESSION_HERE\",\n\"dp_prompt\": \"A beautiful sunset over the ocean\",\n\"dp_callback_url\": \"https://example.com/callback\",\n\"dp_aspect_ratio\": \"1:1\",\n\"dp_medium\": \"art\"\n}'\n```\n\n#### Example of a request in form-data format:\n```bash\ncurl --silent https://api.depositphotos.com \\\n-d 'dp_command=imageGenerator.generate&dp_apikey=INSERT_YOUR_API_KEY_HERE&dp_session_id=INSERT_YOUR_AUTH_SESSION_HERE&dp_prompt=A beautiful sunset over the ocean&dp_callback_url=https://example.com/callback&dp_aspect_ratio=1:1&dp_medium=art'\n```\n\n## Response Format\nEach API method returns a structured JSON response. The response always includes a `type` field to indicate the request status:\n\n### Success Response Format\n```json\n {\n \"timestamp\": \"2025-02-14 11:14:30\",\n \"version\": \"1.3\",\n \"type\": \"success\",\n \"data\": { ... }\n }\n```\n\n### Error Response Format\n```json\n {\n \"timestamp\": \"2025-02-14 11:14:30\",\n \"version\": \"1.3\",\n \"type\": \"failure\",\n \"error\": {\n \"errorcode\": 403,\n \"errormsg\": \"Session ID invalid or session is expired\",\n \"exception\": \"AuthenticationError\"\n }\n }\n```\n\n### API specification\nFor further details on specific API methods, please refer to the method documentation in the **API Reference** section.\n\nAlso you can Download OpenAPI specification for Creative Suite API.\n\n### Support information\n\n**Support channels:** Reach out to our dedicated technical support team at support@depositphotos.com or use Live Chat.\nAdditional contact details can be found at the Depositphotos [Contact Us](https://depositphotos.com/contact_us.html) page.\n\n### Legal Information\n\nUsers must agree to the [API Program Agreement](https://depositphotos.com/api-agreement.html) and licensing agreements before accessing the API.\nThese documents ensure compliance with copyright laws.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "6007824" }, "item": [ { "name": "?dp_command=audio.genres.getList", "item": [ { "name": "Get music genres", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.genres.getList&dp_command=audio.genres.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.genres.getList" }, { "key": "dp_command", "value": "audio.genres.getList", "description": "(Required) Command to execute" } ] }, "description": "Retrieve all music genres with their ids, which can be used in [**search command**](https://create.vista.com/suite-api/doc/api-reference/search-content)" }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.genres.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.genres.getList", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"result\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\"\n }\n ]\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.genres.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.genres.getList", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=audio.instruments.getList", "item": [ { "name": "Get music Instruments", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.instruments.getList&dp_command=audio.instruments.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.instruments.getList" }, { "key": "dp_command", "value": "audio.instruments.getList", "description": "(Required) Command to execute" } ] }, "description": "Retrieve all music instruments with their ids, which can be used in [**search command**](https://create.vista.com/suite-api/doc/api-reference/search-content)" }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.instruments.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.instruments.getList", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"result\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.instruments.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.instruments.getList", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=audio.moods.getList", "item": [ { "name": "Get music moods", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.moods.getList&dp_command=audio.moods.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.moods.getList" }, { "key": "dp_command", "value": "audio.moods.getList", "description": "(Required) Command to execute" } ] }, "description": "Retrieve all music moods with their ids, which can be used in [**search command**](https://create.vista.com/suite-api/doc/api-reference/search-content)" }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.moods.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.moods.getList", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"result\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.moods.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.moods.getList", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=audio.soundEffects.getList", "item": [ { "name": "Get sound effect types", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.soundEffects.getList&dp_command=audio.soundEffects.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.soundEffects.getList" }, { "key": "dp_command", "value": "audio.soundEffects.getList", "description": "(Required) Command to execute" } ] }, "description": "Retrieve all sound effect types with their ids, which can be used in [**search command**](https://create.vista.com/suite-api/doc/api-reference/search-content)" }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.soundEffects.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.soundEffects.getList", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"result\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\"\n }\n ]\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=audio.soundEffects.getList", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "audio.soundEffects.getList", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=changePassword", "item": [ { "name": "Change Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=changePassword&dp_command=changePassword&dp_old_password=&dp_new_password=", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "changePassword" }, { "key": "dp_command", "value": "changePassword", "description": "(Required) Command to execute" }, { "key": "dp_old_password", "value": "", "description": "(Required) " }, { "key": "dp_new_password", "value": "", "description": "(Required) " } ] }, "description": "Change password for the user that uses in the [**Login command**](https://create.vista.com/suite-api/doc/api-reference/login)." }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=changePassword&dp_old_password=&dp_new_password=", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "changePassword", "description": "(Required) Command to execute" }, { "key": "dp_old_password", "value": "", "description": "(Required) " }, { "key": "dp_new_password", "value": "", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\"\n}" } ] } ] }, { "name": "?dp_command=editor.partner.createAutomateDesignJob", "item": [ { "name": "Create Automate Design Job", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_response_type\": \"pure\",\n \"dp_values\": {\n \"value_to_set\": \"\",\n \"action_type\": \"setBackground\",\n \"field_to_update\": \"\",\n \"opts\": {\n \"fit_image_mode\": \"cover\",\n \"flex_text\": \"\"\n },\n \"upload_opts\": {\n \"element_type\": \"videoElement\",\n \"dimensions\": {\n \"width\": \"\",\n \"height\": \"\"\n }\n }\n },\n \"dp_project_id\": \"\",\n \"dp_template_id\": \"\",\n \"dp_partner_template_id\": \"\",\n \"dp_external_user_id\": \"\",\n \"dp_format\": \"gif\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.createAutomateDesignJob&dp_command=editor.partner.createAutomateDesignJob", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.createAutomateDesignJob" }, { "key": "dp_command", "value": "editor.partner.createAutomateDesignJob", "description": "(Required) Command to execute" } ] }, "description": "This endpoint allows you to create automated design jobs.\n\n**Usage Notes**\n- You must provide either `dp_project_id`, `dp_template_id`, or `dp_partner_template_id` in your request.\n- The `dp_response_type` field determines the format of the response.\n- When using `dp_format`, ensure your partner account has the corresponding download feature enabled.\n- The optional `dp_external_user_id` field allows you to perform actions on behalf of specific users.\n- In the `dp_values` object or array, provide the necessary information for the automation action(s):\n - `value_to_set`: The new value to be set (e.g., new text content or image URL)\n - `field_to_update`: In basic cases, this is a string that holds the value UUID of the element object in the project that should be updated, but for cases involving the action 'ReplaceText,' this field can contain the text we want to replace. In other words, we pass the text that will be used to search for the text block we will further work with to replace it. It is also important to note that if you want to use the replaceText feature, you have to pass the exact same string to the field_to_update property. The search is case-sensitive and must be an exact match, including special newline characters like \\n.\n - `action_type`: Specifies what kind of automation to perform. Use one of the values from the Action Types section.\n - `opts`: Additional options specific to the chosen `action_type`. See the Action-Specific Options section for details.\n - `upload_opts`: Additional options for image-related actions. The `element_type` is required, while `dimensions` is optional.\n - The `fit_image_mode` option is only available for the `replaceImage` action.\n - For `replaceText`, the `flex_text` option determines whether the text size adjusts to fit the designated area.\n - You can perform multiple actions in a single request by providing an array of action objects in the `dp_values` field.\n\n**Example Requests**\n\n- Replace Image:\n```json\n {\n \"dp_project_id\": \"5bbb5d28c0af6826095aa7e4\",\n \"dp_response_type\": \"pure\",\n \"dp_external_user_id\": \"user-123\",\n \"dp_values\": {\n \"value_to_set\": \"https://example.com/new-image.jpg\",\n \"field_to_update\": \"image-element-uuid\",\n \"action_type\": \"replaceImage\",\n \"opts\": {\n \"fit_image_mode\": \"cover\"\n },\n \"upload_opts\": {\n \"element_type\": \"imageElement\",\n \"dimensions\": {\n \"width\": 800,\n \"height\": 600\n }\n }\n }\n }\n```\n\n- Add Image (using dp_template_id):\n```json\n {\n \"dp_template_id\": \"5bbb5d28c0af6826095aa7e5\",\n \"dp_response_type\": \"preview\",\n \"dp_external_user_id\": \"user-456\",\n \"dp_values\": {\n \"value_to_set\": \"https://example.com/new-image.jpg\",\n \"action_type\": \"addImage\",\n \"upload_opts\": {\n \"element_type\": \"imageElement\",\n \"dimensions\": {\n \"width\": 400,\n \"height\": 300\n }\n }\n }\n }\n```\n\n- Replace Text with Download (using dp_partner_template_id):\n```json\n {\n \"dp_partner_template_id\": \"partner-template-001\",\n \"dp_response_type\": \"download\",\n \"dp_format\": \"pngTransparent\",\n \"dp_external_user_id\": \"user-789\",\n \"dp_values\": {\n \"value_to_set\": \"New text content\",\n \"field_to_update\": \"text-element-uuid\" or \"text-replacement\",\n \"action_type\": \"replaceText\",\n \"opts\": {\n \"flex_text\": true\n }\n }\n }\n```" }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_response_type\": \"pure\",\n \"dp_values\": {\n \"value_to_set\": \"\",\n \"action_type\": \"setBackground\",\n \"field_to_update\": \"\",\n \"opts\": {\n \"fit_image_mode\": \"cover\",\n \"flex_text\": \"\"\n },\n \"upload_opts\": {\n \"element_type\": \"videoElement\",\n \"dimensions\": {\n \"width\": \"\",\n \"height\": \"\"\n }\n }\n },\n \"dp_project_id\": \"\",\n \"dp_template_id\": \"\",\n \"dp_partner_template_id\": \"\",\n \"dp_external_user_id\": \"\",\n \"dp_format\": \"gif\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.createAutomateDesignJob", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.createAutomateDesignJob", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"data\": {\n \"jobId\": \"\"\n }\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_response_type\": \"pure\",\n \"dp_values\": {\n \"value_to_set\": \"\",\n \"action_type\": \"setBackground\",\n \"field_to_update\": \"\",\n \"opts\": {\n \"fit_image_mode\": \"cover\",\n \"flex_text\": \"\"\n },\n \"upload_opts\": {\n \"element_type\": \"videoElement\",\n \"dimensions\": {\n \"width\": \"\",\n \"height\": \"\"\n }\n }\n },\n \"dp_project_id\": \"\",\n \"dp_template_id\": \"\",\n \"dp_partner_template_id\": \"\",\n \"dp_external_user_id\": \"\",\n \"dp_format\": \"gif\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.createAutomateDesignJob", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.createAutomateDesignJob", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=editor.partner.getAutomateDesignJob", "item": [ { "name": "Get Automate Design Job", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_job_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.getAutomateDesignJob&dp_command=editor.partner.getAutomateDesignJob", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.getAutomateDesignJob" }, { "key": "dp_command", "value": "editor.partner.getAutomateDesignJob", "description": "(Required) Command to execute" } ] }, "description": "Retrieves the status and details of an automated design job using its unique job ID.\n\n**Usage Notes**\n1. Ensure you have the necessary authentication to access this API endpoint.\n\n2. The `id` in the URL should be the jobId you received when creating the automated design job.\n\n3. The `status` field indicates the current state of the job. You may need to poll this endpoint if the job is not yet complete.\n\n4. The `ghostDesignerJobs` array may contain multiple jobs if the automation involves multiple designs or variations.\n\n5. Use the `downloadLink` to retrieve the final design files once the job is complete.\n\n6. The `previewLink` can be used to show a preview of the design to users before downloading.\n\n7. Check the `error` field for any issues that occurred during the job processing." }, "response": [ { "name": "Responses with 200 HTTP code\n\nNote: for each response type `ghostDesignerJobs` payload will be different (status, jobId, error will be the same for all)\n\nfor `download` you will have `downloadLink` and `downloadJobId`\n\nfor `preview` you will have `preview", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_job_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.getAutomateDesignJob", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.getAutomateDesignJob", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"data\": {\n \"jobId\": \"\",\n \"status\": \"failed\",\n \"partnerId\": \"\",\n \"responseType\": \"\",\n \"duplicateProject\": \"\",\n \"projectId\": \"\",\n \"ghostDesignerJobs\": [\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"downloadJobId\": \"\",\n \"downloadLink\": \"\",\n \"previewLink\": \"\",\n \"error\": \"\",\n \"pagePreviews\": {\n \"tNGEZFn8EaSA4f3a7LYvJqFEEI2c44LlQdQIxvmbubOcUM22rTI6e2n8M70oq4Gv\": {\n \"path\": \"\",\n \"updatedAt\": \"\"\n }\n }\n },\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"downloadJobId\": \"\",\n \"downloadLink\": \"\",\n \"previewLink\": \"\",\n \"error\": \"\",\n \"pagePreviews\": {\n \"tNGEZFn8EaSA4f3a7LYvJqFEEI2c44LlQdQIxvmbubOcUM22rTI6e2n8M70oq4Gv\": {\n \"path\": \"\",\n \"updatedAt\": \"\"\n }\n }\n }\n ]\n }\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_job_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.getAutomateDesignJob", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.getAutomateDesignJob", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=editor.partner.getFormatKeys", "item": [ { "name": "Get Format Keys", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.getFormatKeys&dp_command=editor.partner.getFormatKeys", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.getFormatKeys" }, { "key": "dp_command", "value": "editor.partner.getFormatKeys", "description": "(Required) Command to execute" } ] }, "description": "Returns Format Keys (associated with your API) to create filters:" }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.getFormatKeys", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.getFormatKeys", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"data\": [\n \"\",\n \"\"\n ]\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.getFormatKeys", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.getFormatKeys", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=editor.partner.getUserProjects", "item": [ { "name": "Get User Projects", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_external_user_id\": \"\",\n \"dp_format_Key\": \"\",\n \"dp_skip\": \"\",\n \"dp_limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.getUserProjects&dp_command=editor.partner.getUserProjects", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.getUserProjects" }, { "key": "dp_command", "value": "editor.partner.getUserProjects", "description": "(Required) Command to execute" } ] }, "description": "Returns user projects by external user id." }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_external_user_id\": \"\",\n \"dp_format_Key\": \"\",\n \"dp_skip\": \"\",\n \"dp_limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.getUserProjects", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.getUserProjects", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"formatKey\": \"\",\n \"title\": \"\",\n \"previewImageUrls\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"formatKey\": \"\",\n \"title\": \"\",\n \"previewImageUrls\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"count\": \"\"\n }\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_external_user_id\": \"\",\n \"dp_format_Key\": \"\",\n \"dp_skip\": \"\",\n \"dp_limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=editor.partner.getUserProjects", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "editor.partner.getUserProjects", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=imageBgRemover.removeBg", "item": [ { "name": "Remove Image Background", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "image/png" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_image_url\": \"\",\n \"dp_session_id\": \"\",\n \"dp_image_base64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=imageBgRemover.removeBg&dp_command=imageBgRemover.removeBg", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "imageBgRemover.removeBg" }, { "key": "dp_command", "value": "imageBgRemover.removeBg", "description": "(Required) Command to execute" } ] }, "description": "API access to an AI-powered tool for automated removal of backgrounds from JPG and PNG images.\nThe algorithms recognize an image’s background and foreground, and creates a PNG file with an\nobject on a transparent background.\nTo integrate the tool with your product and start processing images on your website, select an API plan with a monthly limit of images that meets your needs.\n\nAllowed image types: `image/png`, `image/jpg`, `image/jpeg`, `image/webp`" }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "image/png" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_image_url\": \"\",\n \"dp_session_id\": \"\",\n \"dp_image_base64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=imageBgRemover.removeBg", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "imageBgRemover.removeBg", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Width", "value": "", "description": { "content": "Width of the result image.", "type": "text/plain" } }, { "key": "X-Height", "value": "", "description": { "content": "Height of the result image.", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_image_url\": \"\",\n \"dp_session_id\": \"\",\n \"dp_image_base64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=imageBgRemover.removeBg", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "imageBgRemover.removeBg", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=imageGenerator.generate", "item": [ { "name": "Generate Image", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_session_id\": \"\",\n \"dp_prompt\": \"\",\n \"dp_callback_url\": \"\",\n \"dp_aspect_ratio\": \"5:4\",\n \"dp_medium\": \"art\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=imageGenerator.generate&dp_command=imageGenerator.generate", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "imageGenerator.generate" }, { "key": "dp_command", "value": "imageGenerator.generate", "description": "(Required) Command to execute" } ] }, "description": "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**](https://create.vista.com/suite-api/doc/api-reference/get-image-generator-data)." }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_session_id\": \"\",\n \"dp_prompt\": \"\",\n \"dp_callback_url\": \"\",\n \"dp_aspect_ratio\": \"5:4\",\n \"dp_medium\": \"art\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=imageGenerator.generate", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "imageGenerator.generate", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"data\": {\n \"uuid\": \"\",\n \"prompt\": \"\",\n \"status\": \"\",\n \"purchaseStatus\": \"\",\n \"items\": [\n {\n \"uuid\": \"\",\n \"dpItemId\": \"\",\n \"previewUrl\": \"\"\n },\n {\n \"uuid\": \"\",\n \"dpItemId\": \"\",\n \"previewUrl\": \"\"\n }\n ]\n }\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_session_id\": \"\",\n \"dp_prompt\": \"\",\n \"dp_callback_url\": \"\",\n \"dp_aspect_ratio\": \"5:4\",\n \"dp_medium\": \"art\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=imageGenerator.generate", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "imageGenerator.generate", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=imageGenerator.get", "item": [ { "name": "Get Image Generator Data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_session_id\": \"\",\n \"dp_uuid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=imageGenerator.get&dp_command=imageGenerator.get", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "imageGenerator.get" }, { "key": "dp_command", "value": "imageGenerator.get", "description": "(Required) Command to execute" } ] }, "description": "Retrieves the status and details of a generated image using its unique prompt UUID." }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_session_id\": \"\",\n \"dp_uuid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=imageGenerator.get", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "imageGenerator.get", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"data\": {\n \"uuid\": \"\",\n \"prompt\": \"\",\n \"status\": \"completed\",\n \"purchaseStatus\": \"paid\",\n \"items\": [\n {\n \"uuid\": \"\",\n \"dpItemId\": \"\",\n \"previewUrl\": \"\"\n },\n {\n \"uuid\": \"\",\n \"dpItemId\": \"\",\n \"previewUrl\": \"\"\n }\n ]\n }\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_session_id\": \"\",\n \"dp_uuid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=imageGenerator.get", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "imageGenerator.get", "description": "(Required) Command to execute" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"error\": {\n \"errorcode\": \"\",\n \"errormsg\": \"\",\n \"exception\": \"\"\n }\n}" } ] } ] }, { "name": "?dp_command=item.get", "item": [ { "name": "Get Item Data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_item_id\": \"\",\n \"dp_full_similar\": \"\",\n \"dp_translate_items\": \"\",\n \"dp_translate_similars\": \"\",\n \"dp_lang\": \"\",\n \"dp_country_excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=item.get&dp_command=item.get", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "item.get" }, { "key": "dp_command", "value": "item.get", "description": "(Required) Command to execute" } ] }, "description": "Retrieve all information about the media item." }, "response": [ { "name": "Responses with 200 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_item_id\": \"\",\n \"dp_full_similar\": \"\",\n \"dp_translate_items\": \"\",\n \"dp_translate_similars\": \"\",\n \"dp_lang\": \"\",\n \"dp_country_excluded\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/?dp_command=item.get", "host": [ "{{baseUrl}}" ], "path": [ "" ], "query": [ { "key": "dp_command", "value": "item.get", "description": "(Required) Command to execute" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timestamp\": \"\",\n \"version\": \"\",\n \"type\": \"\",\n \"data\": {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"isFreeItem\": \"\",\n \"itemUrl\": \"\",\n \"published\": \"\",\n \"updated\": \"\",\n \"metaData\": {\n \"originalFilesize\": \"\",\n \"originalExtension\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"mp\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"author\": {\n \"userId\": \"\",\n \"username\": \"\",\n \"level\": \"\",\n \"avatar\": \"\"\n },\n \"thumbs\": {\n \"thumb110\": \"\",\n \"thumb170\": \"\",\n \"thumb380\": \"\",\n \"thumb450\": \"\",\n \"thumb600\": \"\",\n \"thumb950\": \"\",\n \"video\": \"\",\n \"audio\": \"\"\n },\n \"similar\": {\n \"757025912\": {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"originalTitle\": \"\",\n \"originalDescription\": \"\",\n \"type\": \"\",\n \"isFreeItem\": \"\",\n \"itemUrl\": \"\",\n \"thumbs\": {\n \"thumb110\": \"\",\n \"thumb170\": \"\",\n \"thumb380\": \"\",\n \"thumb450\": \"\",\n \"video\": \"\",\n \"audio\": \"\"\n },\n \"metaData\": {\n \"originalFilesize\": \"\",\n \"originalExtension\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"mp\": \"\"\n }\n }\n },\n \"sameModel\": {\n \"757025912\": {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"originalTitle\": \"\",\n \"originalDescription\": \"\",\n \"type\": \"\",\n \"isFreeItem\": \"\",\n \"itemUrl\": \"\",\n \"thumbs\": {\n \"thumb110\": \"\",\n \"thumb170\": \"\",\n \"thumb380\": \"\",\n \"thumb450\": \"\",\n \"video\": \"\",\n \"audio\": \"\"\n },\n \"metaData\": {\n \"originalFilesize\": \"\",\n \"originalExtension\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"mp\": \"\"\n }\n }\n },\n \"sameSeries\": {\n \"757025912\": {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"originalTitle\": \"\",\n \"originalDescription\": \"\",\n \"type\": \"\",\n \"isFreeItem\": \"\",\n \"itemUrl\": \"\",\n \"thumbs\": {\n \"thumb110\": \"\",\n \"thumb170\": \"\",\n \"thumb380\": \"\",\n \"thumb450\": \"\",\n \"video\": \"\",\n \"audio\": \"\"\n },\n \"metaData\": {\n \"originalFilesize\": \"\",\n \"originalExtension\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"mp\": \"\"\n }\n }\n }\n }\n}" }, { "name": "Responses with 403 HTTP code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dp_apikey\": \"\",\n \"dp_item_id\": \"\",\n \"dp_full_similar\": \"