{ "openapi": "3.0.1", "info": { "title": "AI Video Ads Generator", "description": "This actor generates AI-powered video ads for your products, brands, or services. You can create professional-quality videos for social media platforms like Instagram, TikTok, YouTube, and Facebook in minutes.", "version": "0.1", "x-build-id": "pNUEcfTeF4xWBCduH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/peaceful_pushpins~ai-video-ads-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-peaceful_pushpins-ai-video-ads-generator", "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-video-ads-generator/runs": { "post": { "operationId": "runs-sync-peaceful_pushpins-ai-video-ads-generator", "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-video-ads-generator/run-sync": { "post": { "operationId": "run-sync-peaceful_pushpins-ai-video-ads-generator", "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", "required": [ "productName", "targetAudience", "platform", "videoFormat", "adDuration", "basePrompt" ], "properties": { "productName": { "title": "Product Name", "minLength": 1, "type": "string", "description": "Name of the product you want to create an AI video ad for", "default": "Nike No-Show Socks" }, "referenceImage1": { "title": "Reference Image 1", "type": "string", "description": "**CRITICAL:** This image sets the aspect ratio. Ensure it matches your **Platform/Video Format** choice (e.g., 9:16 for TikTok, 16:9 for YouTube). Use .jpg or .png." }, "referenceImage2": { "title": "Reference Image 2", "type": "string", "description": "Optional second angle. **Note:** Should have the same dimensions as Image 1." }, "referenceImage3": { "title": "Reference Image 3", "type": "string", "description": "Optional third angle. **Note:** Should have the same dimensions as Image 1." }, "targetAudience": { "title": "Target Audience", "minLength": 5, "maxLength": 200, "type": "string", "description": "1-3 target audience names separated by commas, e.g. young adults, fitness enthusiasts, parents, etc.", "default": "Athletes, Fitness Enthusiasts, Runners" }, "adGoal": { "title": "Enter your Ad goal", "type": "string", "description": "What is the end goal of your Ad?", "default": "Promote comfort and performance for active lifestyles" }, "platform": { "title": "Target Platform", "enum": [ "instagram", "tiktok", "youtube", "facebook" ], "type": "string", "description": "Select the social media platform where this video ad will be published. The platform helps automatically choose the best video dimensions.", "default": "instagram" }, "videoFormat": { "title": "Video Format", "enum": [ "auto", "portrait", "landscape_hd", "landscape", "square", "low" ], "type": "string", "description": "Choose Auto for best quality or Low for fastest & cheapest generation.", "default": "auto" }, "adDuration": { "title": "Duration", "enum": [ "3", "5", "10" ], "type": "string", "description": "Length of the generated video ad in seconds. Shorter durations are faster and cheaper, longer durations allow more detail.", "default": "3" }, "brandTone": { "title": "Brand tone", "type": "string", "description": "Describe your brand tone in one word such as fun, luxury, etc.", "default": "Fun" }, "brandStory": { "title": "Brand Story", "minLength": 50, "maxLength": 500, "type": "string", "description": "Tell your brand’s journey, mission, and values in 10–40 words...", "default": "Nike has been creating innovative and comfortable athletic wear for decades. These no-show socks are designed to provide maximum comfort, performance, and style for runners and fitness enthusiasts alike." }, "visualStyle": { "title": "Visual Style", "enum": [ "Cinematic", "Animated", "UGC", "Artistic", "Normal" ], "type": "string", "description": "Please choose the visual style of your video", "default": "Normal" }, "keySellingPoints": { "title": "Key Selling Points", "minLength": 20, "maxLength": 200, "type": "string", "description": "Write your key selling points separated by commas such as No Sugar, Comfortable, etc.", "default": "comfortable, anti-bacterial" }, "colors": { "title": "Brand Colors", "minLength": 0, "maxLength": 100, "type": "string", "description": "3 brand colors in hex format each on a new line or leave it empty.", "default": "#87CEFA\n#C2C2C2" }, "basePrompt": { "title": "Prompt", "minLength": 50, "maxLength": 300, "type": "string", "description": "Describe the video you want to generate. You can mention the product, environment, actions, mood, camera movement, and overall style.", "default": "Create a high-energy promotional video showing Nike No-Show Socks in action. Highlight comfort, style, and performance for runners. Please create a motion video from reference image, show product from reference image if available and do not hallucinate." }, "variants": { "title": "Variants", "enum": [ "similar", "different", "none" ], "type": "string", "description": "Generate up to 3 similar or different variants of Ad video at one time, none if you want to generate 1 video.", "default": "none" }, "steps": { "title": "Video Generation Steps", "minimum": 4, "maximum": 50, "type": "integer", "description": "Select number of steps for video generation. Higher steps improve quality and adherence to reference images.", "default": 20 }, "outputQuality": { "title": "Output Quality", "minimum": 20, "maximum": 100, "type": "integer", "description": "Controls overall quality of generated video. Higher quality may take longer to generate. Quality > 50 uses double the AI processing steps.", "default": 20 } } }, "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 } } } } } } } } } }