{ "openapi": "3.0.1", "info": { "title": "AI Bulk Image Editor", "description": "AI-powered bulk photo editor for influencers, e-commerce, brands, photographers, food bloggers, real estate, and advertisers. Instantly transform up to 1000 images into professional, commercial, or artistic visuals optimized for social media, marketplaces, portfolios, and marketing campaigns.", "version": "0.0", "x-build-id": "Z01Igg8pGS6aTssAY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/peaceful_pushpins~ai-bulk-image-editor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-peaceful_pushpins-ai-bulk-image-editor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/peaceful_pushpins~ai-bulk-image-editor/runs": { "post": { "operationId": "runs-sync-peaceful_pushpins-ai-bulk-image-editor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/peaceful_pushpins~ai-bulk-image-editor/run-sync": { "post": { "operationId": "run-sync-peaceful_pushpins-ai-bulk-image-editor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "imageZipFile": { "title": "Upload Images ZIP Archive", "type": "string", "description": "Upload a .zip file containing 2-1000 images (JPEG/PNG).", "default": "https://api.apify.com/v2/key-value-stores/QbxGhT4BoBa9N2bob/records/Product-Images.zip" }, "qualityTier": { "title": "Quality Tier", "enum": [ "Basic - Seedream-5.0", "Standard - FLUX Kontext Pro (Recommended)", "Standard - Qwen Image 2.0 Pro", "Premium GPT Image", "Premium - FLUX Kontext Max", "Premium - Gemini 3 Pro" ], "type": "string", "description": "Select the quality tier for AI processing. Higher tiers may yield better results but take more time and resources.", "default": "Standard - FLUX Kontext Pro (Recommended)" }, "noOfImages": { "title": "Select the number of images you wanted to edit", "minimum": 10, "maximum": 1000, "type": "integer", "description": "Choose a number between 10 and 1000", "default": 10 }, "editingMode": { "title": "Editing Mode", "enum": [ "Product Advertising", "Professional", "Artistic" ], "type": "string", "description": "Select the AI editing mode that best matches your image editing goals.", "default": "Product Advertising" }, "productPresentation": { "title": "Product Presentation Style (Only enabled, if Editing Mode is Product Photography & Advertising)", "type": "array", "description": "Select the product presentation style. This option is only used when Editing Mode is set to Product Photography & Advertising.", "items": { "type": "string", "enum": [ "Amazon", "Shopify", "Luxury", "Instagram", "MinimalStudio", "DarkPremium", "LifeStyle", "AIDecide" ], "enumTitles": [ "Amazon Listing", "Shopify Store", "Luxury Advertisement", "Instagram Product Ad", "Minimal Studio", "Dark Premium", "Lifestyle Product", "AI Decide (Default)" ] }, "default": [ "AIDecide" ] }, "productCategory": { "title": "Product Category (Only enabled, if Editing Mode is Product Photography & Advertising)", "type": "array", "description": "Select the product category. This option is only used when Editing Mode is set to Product Photography & Advertising.", "items": { "type": "string", "enum": [ "Jewelry", "Electronics", "Food", "Cosmetics", "Fashion", "Furniture", "Automotive", "Technology", "HomeDecor", "Sports", "Pet", "Toys", "AIDecide" ], "enumTitles": [ "Jewelry", "Electronics", "Food Photography", "Cosmetics & Beauty", "Fashion & Apparel", "Furniture & Home", "Automotive", "Technology & Gadgets", "Home Decor", "Sports & Fitness", "Pet Products", "Toys & Games", "AI Decide (Default)" ] }, "default": [ "AIDecide" ] }, "artStyle": { "title": "Art Style (Only enabled, if selected editing mode is Artistic Style Transformation)", "enum": [ "Cartoon", "Anime", "Ghibli", "Comic Book", "Watercolor", "Oil Painting", "Pencil Sketch", "Cyberpunk", "Vintage Film", "Pixar", "Clay", "3D Render", "Pop Art", "Custom" ], "type": "string", "description": "Select your art style for image editing. It will only be enabled, if selected mode is Artistic Style Transformation otherwise ignored.", "default": "Ghibli" }, "manualOptions": { "title": "Manual Photography Editing Options (Only selected, if Editing Mode is Professional Photo Editing)", "type": "array", "description": "Select one or more options for photo editing feature.", "items": { "type": "string", "enum": [ "cleanup", "background_swap", "flyaway_hair", "monochrome_retouch", "teeth_eyes_brighten", "lighting_adjustment" ], "enumTitles": [ "Object Cleanup / De-wrinkle / Skin Retouching", "Background Modification (Remove/Replace)", "Fix Flyaway Hair", "MonoChrome Retouch (B&W with AI Enhancements)", "Enhance Eyes & Teeth", "Lighting (Lighten/Darken)" ] }, "default": [ "cleanup" ] }, "manualOptionsProduct": { "title": "Manual Product Editing Options (Only selected, if Editing Mode is Product Photography & Advertising)", "type": "array", "description": "Select additional product editing enhancements to apply. These options are only used when Editing Mode is set to Product Photography & Advertising.", "items": { "type": "string", "enum": [ "Improve Lighting", "Enhance Product Sharpness", "Increase Contrast", "Improve White Balance", "Improve Color Accuracy", "Reduce Image Noise", "Remove Background", "Clean Background", "Replace Background", "Add Soft Shadow", "Add Reflection", "Create Floating Product Effect", "Remove Dust & Scratches", "Remove Fingerprints", "Remove Packaging Imperfections", "Enhance Packaging Details", "Improve Label Readability", "Enhance Branding Visibility", "Improve Product Visibility", "Center Product", "Improve Composition", "Improve Symmetry", "Enhance Material Texture", "Increase Shelf Appeal", "Luxury Commercial Finish", "Amazon Listing Optimization", "Shopify Store Optimization", "Social Media Ready", "Catalog Ready", "Advertisement Ready", "AI Decide (Default)" ] }, "default": [ "AI Decide (Default)" ] }, "targetAudiences": { "title": "Target Audiences", "type": "array", "description": "Select one or more audiences. Select the audiences for your images to guide the AI's editing style.", "items": { "type": "string", "enum": [ "general_social_media", "fashion", "beauty", "fitness", "luxury", "real_estate", "travel", "food", "ecommerce", "professional_linkedin" ], "enumTitles": [ "General Social Media", "Fashion Influencers", "Beauty Influencers", "Fitness Influencers", "Luxury Brands", "Real Estate", "Travel Content", "Food Bloggers", "E-Commerce Products", "Professional LinkedIn" ] }, "default": [ "general_social_media" ] }, "editingStyle": { "title": "Editing Style", "enum": [ "natural", "commercial", "editorial", "cinematic", "luxury", "vibrant", "moody", "minimalist", "AIDecide" ], "type": "string", "description": "Choose an overall editing style to guide the AI's adjustments.", "default": "AIDecide" }, "platform": { "title": "Target Platform", "enum": [ "instagram", "tiktok", "youtube", "linkedin", "facebook", "pinterest", "eBay", "Alibaba / AliExpress", "OLX", "Etsy", "Facebook Marketplace", "Walmart Marketplace", "Unsplash", "Pexels", "500px", "Flickr", "Behance", "Shutterstock" ], "type": "string", "description": "Select the primary platform where the edited images will be used. This helps the AI optimize edits for that platform's style and audience.", "default": "Facebook Marketplace" }, "transformationLevel": { "title": "Transformation Level", "enum": [ "Light Touch", "Moderate", "Complete Makeover" ], "type": "string", "description": "Select the level of transformation you want the AI to apply to the images.", "default": "Moderate" }, "backgroundColorValue": { "title": "Background Color", "minLength": 0, "maxLength": 300, "type": "string", "description": "Enter hex codes (e.g., #FF5733) or descriptions (e.g., 'Soft teal with a hint of gold gradient')." }, "userInstructions": { "title": "Custom User Prompt / Reference Instructions", "minLength": 0, "maxLength": 500, "type": "string", "description": "Optional instructions for background modifications or manual styles." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }