{
  "openapi": "3.0.1",
  "info": {
    "title": "Image Branding & Social Formatter",
    "description": "Upload your images or provide URLs. This Actor will apply your logo, optional text overlay, and generate ready-to-post versions for Instagram, TikTok, Pinterest, X, Facebook and LinkedIn.",
    "version": "0.0",
    "x-build-id": "xraNVQOKOac3fW67Z"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/badruddeen~image-branding-social-formatter/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-badruddeen-image-branding-social-formatter",
        "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/badruddeen~image-branding-social-formatter/runs": {
      "post": {
        "operationId": "runs-sync-badruddeen-image-branding-social-formatter",
        "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/badruddeen~image-branding-social-formatter/run-sync": {
      "post": {
        "operationId": "run-sync-badruddeen-image-branding-social-formatter",
        "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": {
          "safeMode": {
            "title": "Safe Mode",
            "type": "boolean",
            "description": "When ON, ensures the actor runs safely during automated checks (Apify auto-checks). Can be turned OFF manually.",
            "default": true
          },
          "imageUrls": {
            "title": "Image URLs",
            "type": "array",
            "description": "Add one or more public image URLs. Each URL is processed as a separate source.",
            "items": {
              "type": "string",
              "enumSuggestedValues": [
                "https://example.com/image1.jpg"
              ],
              "enumTitles": [
                "Example image 1"
              ]
            }
          },
          "uploadedImages": {
            "title": "Upload Images",
            "type": "array",
            "description": "Upload one or more images (JPG, PNG, WEBP recommended). Each file will be processed as a separate source image.",
            "items": {
              "type": "string"
            }
          },
          "logoUpload": {
            "title": "Logo / Watermark (optional)",
            "type": "string",
            "description": "Upload a transparent PNG logo for watermarking. If omitted, the bundled logo (if present) will be used. If none exists, images will be generated without a logo."
          },
          "logoEnabled": {
            "title": "Logo ON / OFF",
            "type": "boolean",
            "description": "Enable or disable logo watermarking. If OFF, no logo will be applied even if a default or uploaded logo exists.",
            "default": true
          },
          "logoScale": {
            "title": "Logo Scale / Size Factor",
            "minimum": 0.05,
            "maximum": 0.5,
            "type": "number",
            "description": "Scale factor for the logo relative to image width (e.g., 0.15 = 15%).",
            "default": 0.15
          },
          "logoPosition": {
            "title": "Logo Position",
            "enum": [
              "top-left",
              "top-right",
              "bottom-left",
              "bottom-right"
            ],
            "type": "string",
            "description": "Select where the logo will be placed on the image.",
            "default": "bottom-right"
          },
          "logoOpacity": {
            "title": "Logo Opacity",
            "minimum": 0,
            "maximum": 1,
            "type": "number",
            "description": "Opacity for the logo watermark (0 = fully transparent, 1 = fully opaque). Applies to all images in the run.",
            "default": 0.85
          },
          "textFont": {
            "title": "Text Font",
            "enum": [
              "Montserrat-Bold",
              "Montserrat-ExtraBold",
              "Oswald-Bold",
              "Poppins-Bold",
              "Opensans-Bold",
              "Roboto-Bold",
              "Lato-Bold"
            ],
            "type": "string",
            "description": "Select the font used for the text overlay. This only affects text added through the Text Overlay field.",
            "default": "Montserrat-ExtraBold"
          },
          "overlayText": {
            "title": "Text Overlay (optional)",
            "type": "string",
            "description": "Optional text to overlay on the image (e.g., SALE 50% OFF)."
          },
          "textPosition": {
            "title": "Text Position",
            "enum": [
              "top-left",
              "top-right",
              "bottom-left",
              "bottom-right",
              "center"
            ],
            "type": "string",
            "description": "Select where the text will appear. Text will auto-offset if it overlaps the logo.",
            "default": "center"
          },
          "textSizeFactor": {
            "title": "Text Scale / Size Factor",
            "minimum": 0.05,
            "maximum": 0.5,
            "type": "number",
            "description": "Scale factor for text relative to image width.",
            "default": 0.1
          },
          "textOpacity": {
            "title": "Text Opacity",
            "minimum": 0,
            "maximum": 1,
            "type": "number",
            "description": "Opacity for the overlay text (0 = fully transparent, 1 = fully opaque). Applies to all images in the run.",
            "default": 1
          },
          "textColor": {
            "title": "Text Color",
            "enum": [
              "#ffffff",
              "#000000",
              "#ff0000",
              "#00ff00",
              "#0000ff",
              "#ffff00",
              "#ff00ff",
              "#00ffff",
              "#808080",
              "#ffa500",
              "#800000",
              "#008000",
              "#000080",
              "#800080",
              "#008080",
              "#c0c0c0",
              "#f0f8ff",
              "#faebd7",
              "#7fffd4",
              "#ffe4c4"
            ],
            "type": "string",
            "description": "Select the color of the text overlay. Applies to all images in the run.",
            "default": "#ffffff"
          },
          "textStrokeColor": {
            "title": "Text Stroke Color",
            "enum": [
              "#000000",
              "#ffffff",
              "#ff0000",
              "#0000ff",
              "#ffff00",
              "#00ff00"
            ],
            "type": "string",
            "description": "Outline color around the text for better readability.",
            "default": "#000000"
          },
          "textShadowEnabled": {
            "title": "Enable Text Shadow",
            "type": "boolean",
            "description": "Adds a soft drop shadow behind the text for better readability on varied backgrounds.",
            "default": true
          },
          "textShadowColor": {
            "title": "Text Shadow Color",
            "enum": [
              "#000000",
              "#ffffff",
              "rgba(0,0,0,0.5)",
              "rgba(255,255,255,0.5)",
              "rgba(0,0,0,0.65)"
            ],
            "type": "string",
            "description": "Color of the text shadow. Use rgba for transparency control.",
            "default": "rgba(0,0,0,0.65)"
          },
          "textShadowBlur": {
            "title": "Shadow Blur Radius",
            "minimum": 0,
            "maximum": 20,
            "type": "number",
            "description": "How soft/blurry the shadow appears (higher = more diffused).",
            "default": 5
          },
          "textShadowOffsetX": {
            "title": "Shadow Horizontal Offset",
            "minimum": -15,
            "maximum": 15,
            "type": "number",
            "description": "Horizontal shift of the shadow (positive = right).",
            "default": 2
          },
          "textShadowOffsetY": {
            "title": "Shadow Vertical Offset",
            "minimum": -15,
            "maximum": 15,
            "type": "number",
            "description": "Vertical shift of the shadow (positive = down).",
            "default": 2
          },
          "textMaxLineWidthFactor": {
            "title": "Max Line Width Factor (Wrapping)",
            "minimum": 0.5,
            "maximum": 0.95,
            "type": "number",
            "description": "Fraction of image width allowed per text line before wrapping to the next line (lower = more wrapping).",
            "default": 0.84
          },
          "textLineHeightFactor": {
            "title": "Line Height Multiplier (Wrapping)",
            "minimum": 1,
            "maximum": 2,
            "type": "number",
            "description": "Spacing between wrapped lines (1.0 = tight, 1.5+ = more spaced out).",
            "default": 1.25
          },
          "platforms": {
            "title": "Select Platforms (optional)",
            "uniqueItems": true,
            "type": "array",
            "description": "Select one or more platforms to generate optimized image formats for. If none are selected, all supported platforms will be generated automatically.",
            "items": {
              "type": "string",
              "enum": [
                "instagram",
                "tiktok",
                "pinterest",
                "linkedin",
                "twitter",
                "facebook"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}