{
  "openapi": "3.0.1",
  "info": {
    "title": "AI Banner Generator",
    "description": "Generate professional marketing banners using multiple AI models including Google Gemini, OpenAI DALL-E 3, Stable Diffusion XL, and Midjourney. This Actor automates banner creation with customizable text, colors, dimensions, and styles, plus the ability to revise existing banners.",
    "version": "1.0",
    "x-build-id": "fOl7LgK820ZtiA8uG"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/happitap~ai-banner-generator/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-happitap-ai-banner-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/happitap~ai-banner-generator/runs": {
      "post": {
        "operationId": "runs-sync-happitap-ai-banner-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/happitap~ai-banner-generator/run-sync": {
      "post": {
        "operationId": "run-sync-happitap-ai-banner-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": [
          "aiModel",
          "bannerText"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "generate",
              "revise"
            ],
            "type": "string",
            "description": "Choose whether to generate a new banner or revise an existing one",
            "default": "generate"
          },
          "aiModel": {
            "title": "AI Model",
            "enum": [
              "native",
              "gemini-pro",
              "dall-e-3",
              "stable-diffusion",
              "midjourney"
            ],
            "type": "string",
            "description": "Select the generation method. Native/Canvas is FREE and requires no API key!",
            "default": "native"
          },
          "apiKey": {
            "title": "API Key",
            "type": "string",
            "description": "API key for the selected AI model. NOT REQUIRED for Native/Canvas option. (Gemini: Google AI Studio, DALL-E: OpenAI, Stable Diffusion/Midjourney: Replicate)"
          },
          "bannerText": {
            "title": "Banner Text",
            "type": "string",
            "description": "Main text/headline to display on the banner"
          },
          "subText": {
            "title": "Sub Text (Optional)",
            "type": "string",
            "description": "Secondary text or tagline"
          },
          "bannerStyle": {
            "title": "Banner Style",
            "enum": [
              "modern",
              "minimalist",
              "vibrant",
              "professional",
              "playful",
              "elegant",
              "bold"
            ],
            "type": "string",
            "description": "Visual style for the banner",
            "default": "vibrant"
          },
          "bannerWidth": {
            "title": "Banner Width (px)",
            "minimum": 300,
            "maximum": 3000,
            "type": "integer",
            "description": "Width of the banner in pixels",
            "default": 1200
          },
          "bannerHeight": {
            "title": "Banner Height (px)",
            "minimum": 200,
            "maximum": 2000,
            "type": "integer",
            "description": "Height of the banner in pixels",
            "default": 628
          },
          "primaryColor": {
            "title": "Primary Brand Color",
            "type": "string",
            "description": "Primary color for the banner (hex code)",
            "default": "#FF6B6B"
          },
          "secondaryColor": {
            "title": "Secondary Brand Color",
            "type": "string",
            "description": "Secondary color for the banner (hex code)",
            "default": "#FFA500"
          },
          "industry": {
            "title": "Industry/Category",
            "enum": [
              "ecommerce",
              "technology",
              "fashion",
              "food",
              "travel",
              "finance",
              "healthcare",
              "education",
              "real-estate",
              "entertainment",
              "other"
            ],
            "type": "string",
            "description": "Industry or category for context",
            "default": "ecommerce"
          },
          "existingBannerUrl": {
            "title": "Existing Banner URL (for revision)",
            "type": "string",
            "description": "URL of existing banner to revise (only for 'revise' mode)"
          },
          "revisionInstructions": {
            "title": "Revision Instructions",
            "type": "string",
            "description": "Describe what changes you want to make to the existing banner"
          },
          "numberOfVariations": {
            "title": "Number of Variations",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "How many banner variations to generate",
            "default": 1
          },
          "includeCallToAction": {
            "title": "Include Call-to-Action",
            "type": "boolean",
            "description": "Add a call-to-action button/text to the banner",
            "default": true
          },
          "callToActionText": {
            "title": "Call-to-Action Text",
            "type": "string",
            "description": "Text for the CTA button",
            "default": "Shop Now"
          },
          "outputFormat": {
            "title": "Output Format",
            "enum": [
              "png",
              "jpg",
              "webp"
            ],
            "type": "string",
            "description": "Image format for the generated banners",
            "default": "png"
          },
          "skipTextOverlay": {
            "title": "Skip Text Overlay",
            "type": "boolean",
            "description": "Skip adding text overlay on the banner (use this if AI already generated text in the image)",
            "default": false
          },
          "customPrompt": {
            "title": "Custom AI Prompt (Optional)",
            "type": "string",
            "description": "Provide your own custom prompt for AI image generation. If empty, a prompt will be auto-generated from your inputs. Only works with AI models (not Native/Canvas)."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}