{ "swagger": "2.0", "info": { "title": "Mockups Generator JSON automation", "version": "2026-10-09", "description": "Starter JSON connector. Enter Authorization as Bearer YOUR_API_KEY in the connection. Poll explicitly after 202. Use authenticated HTTP for binary downloads and multipart uploads." }, "host": "web.mockupsgenerator.com", "basePath": "/", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "apiKey": { "type": "apiKey", "in": "header", "name": "Authorization" } }, "security": [ { "apiKey": [] } ], "paths": { "/api/auth/me": { "get": { "operationId": "Accountusage", "summary": "Account usage", "parameters": [], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "plan": { "type": "string" }, "usage": { "type": "object", "properties": { "used": { "type": "integer" }, "allowed": { "type": "integer" } } }, "limits": { "type": "object", "additionalProperties": true } } } } } } }, "/api/v1/dashboard": { "get": { "operationId": "Workspaceoverview", "summary": "Workspace overview", "parameters": [], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/templates": { "get": { "operationId": "Templates", "summary": "Templates", "parameters": [], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/templates/{template_id}": { "get": { "operationId": "Templatedetail", "summary": "Template detail", "parameters": [ { "name": "template_id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/assets": { "get": { "operationId": "Assets", "summary": "Assets", "parameters": [], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/assets/folders": { "get": { "operationId": "Assetfolders", "summary": "Asset folders", "parameters": [], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } }, "post": { "operationId": "Createassetfolder", "summary": "Create asset folder", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": true, "example": { "name": "Approved artwork", "position": 0 }, "properties": { "name": { "type": "string" }, "position": { "type": "integer" } } } } ], "responses": { "201": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/render-jobs": { "post": { "operationId": "Submitrender", "summary": "Submit render", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": true, "example": { "template_id": "REPLACE_TEMPLATE_ID", "options": { "format": "png", "mode": "full", "slots": { "REPLACE_SLOT_ID": { "asset_id": "REPLACE_ASSET_ID", "fit": "contain" } } } }, "properties": { "template_id": { "type": "string" }, "options": { "type": "object", "additionalProperties": true } }, "required": [ "template_id" ] } }, { "name": "Idempotency-Key", "in": "header", "required": true, "type": "string", "maxLength": 200 } ], "responses": { "202": { "description": "Accepted job; poll explicitly", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "completed": { "type": "integer" }, "total": { "type": "integer" }, "error": { "type": "string", "x-nullable": true }, "result_url": { "type": "string", "x-nullable": true }, "has_result": { "type": "boolean" } } } } } } }, "/api/v1/render-jobs/{job_id}": { "get": { "operationId": "Renderstatus", "summary": "Render status", "parameters": [ { "name": "job_id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "completed": { "type": "integer" }, "total": { "type": "integer" }, "error": { "type": "string", "x-nullable": true }, "result_url": { "type": "string", "x-nullable": true }, "has_result": { "type": "boolean" } } } } } } }, "/api/v1/render-jobs/{job_id}/cancel": { "post": { "operationId": "Cancelrender", "summary": "Cancel render", "parameters": [ { "name": "job_id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "completed": { "type": "integer" }, "total": { "type": "integer" }, "error": { "type": "string", "x-nullable": true }, "result_url": { "type": "string", "x-nullable": true }, "has_result": { "type": "boolean" } } } } } } }, "/api/v1/render-jobs/{job_id}/retry": { "post": { "operationId": "Retryrender", "summary": "Retry render", "parameters": [ { "name": "job_id", "in": "path", "required": true, "type": "string" } ], "responses": { "202": { "description": "Accepted job; poll explicitly", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "completed": { "type": "integer" }, "total": { "type": "integer" }, "error": { "type": "string", "x-nullable": true }, "result_url": { "type": "string", "x-nullable": true }, "has_result": { "type": "boolean" } } } } } } }, "/api/v1/bulk-jobs/preflight": { "post": { "operationId": "Collectionpreflight", "summary": "Collection preflight", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": true, "example": { "templates": [ { "id": "{{template_id}}", "role_slots": { "artwork": [ "{{slot_id}}" ] } } ], "design_sets": [ { "roles": { "artwork": "{{asset_id}}" } } ], "options": { "format": "png" } }, "properties": { "templates": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "design_sets": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "options": { "type": "object", "additionalProperties": true } } } } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "valid": { "type": "boolean" }, "total": { "type": "integer" }, "credits_required": { "type": "integer" }, "plan_id": { "type": "string" }, "plan_hash": { "type": "string" }, "expires_at": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } }, "/api/v1/bulk-jobs/plans/{plan_id}": { "get": { "operationId": "Reviewedplan", "summary": "Reviewed plan", "parameters": [ { "name": "plan_id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "valid": { "type": "boolean" }, "total": { "type": "integer" }, "credits_required": { "type": "integer" }, "plan_id": { "type": "string" }, "plan_hash": { "type": "string" }, "expires_at": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } }, "/api/v1/bulk-jobs": { "post": { "operationId": "Submitreviewedcollection", "summary": "Submit reviewed collection", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": true, "example": { "plan_id": "{{plan_id}}", "plan_hash": "{{plan_hash}}", "idempotency_key": "{{run_key}}" }, "properties": { "plan_id": { "type": "string" }, "plan_hash": { "type": "string" }, "idempotency_key": { "type": "string" } }, "required": [ "plan_id", "plan_hash", "idempotency_key" ] } } ], "responses": { "202": { "description": "Accepted job; poll explicitly", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "completed": { "type": "integer" }, "total": { "type": "integer" }, "error": { "type": "string", "x-nullable": true }, "result_url": { "type": "string", "x-nullable": true }, "has_result": { "type": "boolean" } } } } } } }, "/api/v1/bulk-jobs/{bulk_job_id}": { "get": { "operationId": "Collectionstatus", "summary": "Collection status", "parameters": [ { "name": "bulk_job_id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "completed": { "type": "integer" }, "total": { "type": "integer" }, "error": { "type": "string", "x-nullable": true }, "result_url": { "type": "string", "x-nullable": true }, "has_result": { "type": "boolean" } } } } } } }, "/api/v1/bulk-jobs/{bulk_job_id}/retry": { "post": { "operationId": "Retrycollection", "summary": "Retry collection", "parameters": [ { "name": "bulk_job_id", "in": "path", "required": true, "type": "string" } ], "responses": { "202": { "description": "Accepted job; poll explicitly", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "completed": { "type": "integer" }, "total": { "type": "integer" }, "error": { "type": "string", "x-nullable": true }, "result_url": { "type": "string", "x-nullable": true }, "has_result": { "type": "boolean" } } } } } } }, "/api/v1/projects": { "get": { "operationId": "Savedprojects", "summary": "Saved projects", "parameters": [], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } }, "post": { "operationId": "Saveeditorproject", "summary": "Save editor project", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": true, "example": { "name": "Approved placement", "kind": "editor", "template_id": "{{template_id}}", "state": { "version": 1, "slots": { "{{slot_id}}": { "asset": { "id": "{{asset_id}}" }, "fit": "contain" } }, "format": "png" } }, "properties": { "name": { "type": "string" }, "kind": { "type": "string" }, "template_id": { "type": "string" }, "state": { "type": "object", "additionalProperties": true } }, "required": [ "template_id" ] } } ], "responses": { "201": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/presets": { "get": { "operationId": "Placementpresets", "summary": "Placement presets", "parameters": [], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/ai/models": { "get": { "operationId": "AImodels", "summary": "AI models", "parameters": [], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/webhook-deliveries": { "get": { "operationId": "Webhookdeliveries", "summary": "Webhook deliveries", "parameters": [], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/templates/{template_id}/editor-export": { "post": { "operationId": "Submiteditorexport", "summary": "Submit editor export", "parameters": [ { "name": "template_id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": true, "example": { "options": { "format": "png", "mode": "full", "slots": { "REPLACE_SLOT_ID": { "asset_id": "REPLACE_ASSET_ID", "fit": "contain" } } } }, "properties": { "options": { "type": "object", "additionalProperties": true } } } }, { "name": "Idempotency-Key", "in": "header", "required": true, "type": "string", "maxLength": 200 } ], "responses": { "202": { "description": "Accepted job; poll explicitly", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "completed": { "type": "integer" }, "total": { "type": "integer" }, "error": { "type": "string", "x-nullable": true }, "result_url": { "type": "string", "x-nullable": true }, "has_result": { "type": "boolean" } } } } } } }, "/api/v1/renders/print-preflight": { "post": { "operationId": "Printpreflight", "summary": "Print preflight", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": true, "example": { "template_id": "REPLACE_TEMPLATE_ID", "options": { "format": "png", "mode": "full", "slots": { "REPLACE_SLOT_ID": { "asset_id": "REPLACE_ASSET_ID", "fit": "contain" } } }, "print_profile": { "width_mm": 254, "height_mm": 304.8, "dpi": 300, "bleed_mm": 3, "safe_area_mm": 5 } }, "properties": { "template_id": { "type": "string" }, "options": { "type": "object", "additionalProperties": true }, "print_profile": { "type": "object", "additionalProperties": true } }, "required": [ "template_id" ] } } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/renders/print-files": { "post": { "operationId": "Printfilesafterwarningreview", "summary": "Print files after warning review", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": true, "example": { "template_id": "REPLACE_TEMPLATE_ID", "options": { "format": "png", "mode": "full", "slots": { "REPLACE_SLOT_ID": { "asset_id": "REPLACE_ASSET_ID", "fit": "contain" } } }, "print_profile": { "width_mm": 254, "height_mm": 304.8, "dpi": 300, "bleed_mm": 3, "safe_area_mm": 5 }, "acknowledge_print_warnings": false }, "properties": { "template_id": { "type": "string" }, "options": { "type": "object", "additionalProperties": true }, "print_profile": { "type": "object", "additionalProperties": true }, "acknowledge_print_warnings": { "type": "boolean" } }, "required": [ "template_id" ] } } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/assets/move": { "post": { "operationId": "Moveartwork", "summary": "Move artwork", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": true, "example": { "asset_ids": [ "{{asset_id}}" ], "folder_id": "{{folder_id}}" }, "properties": { "asset_ids": { "type": "array", "items": { "type": "string" } }, "folder_id": { "type": "string" } } } } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } }, "/api/v1/templates/{template_id}/layers": { "get": { "operationId": "InspectPSDlayers", "summary": "Inspect PSD layers", "parameters": [ { "name": "template_id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "JSON response", "schema": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "status": { "type": "string" } } } } } } } } }