{
  "openapi": "3.0.1",
  "info": {
    "title": "Image SEO Tool: Website Alt Text Checker, PDF Report & Auto-Fix",
    "description": "Find every image missing alt text on any website and get ready-to-paste fixes in EN/FR/AR. Also flags heavy images, no WebP, missing width/height and on-page SEO gaps. CSV + white-label PDF report. A 20-page audit costs about $0.50. Works with WordPress, Wix, Webflow, custom sites and AI agents.",
    "version": "1.1",
    "x-build-id": "FTWkg6LLtHzBjieAt"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/j0l30~website-image-seo-audit/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-j0l30-website-image-seo-audit",
        "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/j0l30~website-image-seo-audit/runs": {
      "post": {
        "operationId": "runs-sync-j0l30-website-image-seo-audit",
        "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/j0l30~website-image-seo-audit/run-sync": {
      "post": {
        "operationId": "run-sync-j0l30-website-image-seo-audit",
        "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": [
          "siteUrl"
        ],
        "properties": {
          "siteUrl": {
            "title": "Website URL",
            "type": "string",
            "description": "Public URL of the website to audit: news, blog, shop or company site on any CMS (WordPress, Drupal, Joomla, Ghost, Webflow, Wix, Magento, custom). Pages are found from robots.txt, sitemap.xml and home page links. Example: https://books.toscrape.com"
          },
          "maxPages": {
            "title": "Max pages",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Maximum number of pages to audit, found from robots.txt, sitemap.xml and home page links. Example: 50",
            "default": 50
          },
          "onlyImagesWithIssues": {
            "title": "Only images that need fixing",
            "type": "boolean",
            "description": "true = return (and charge for) only images with alt text problems. false = return every image. Example: true",
            "default": true
          },
          "altLanguage": {
            "title": "Alt text language",
            "enum": [
              "auto",
              "en",
              "fr",
              "ar"
            ],
            "type": "string",
            "description": "Language of the suggested alt text: auto, en, fr or ar. Auto follows each page's <html lang>, so a bilingual site gets alt text in each page's own language. No AI: suggestions reuse the site's own captions, titles, file names and headings. Example: auto",
            "default": "auto"
          },
          "checkImageSpeed": {
            "title": "Check image speed",
            "type": "boolean",
            "description": "true = flag images over 200 KB, missing width/height (layout shift, CLS), not lazy-loaded below the fold, and JPEG/PNG instead of WebP/AVIF. Size and format use one light HEAD request per image, robots.txt-aware and at least 1 second apart. Example: true",
            "default": true
          },
          "maxImageChecks": {
            "title": "Max images to size-check",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Upper limit of HEAD requests for file size and format (most-used images first). 0 = tag checks only, no extra requests. Example: 50",
            "default": 50
          },
          "baselineDataset": {
            "title": "Proof mode: baseline run's dataset",
            "type": "string",
            "description": "Proof mode: the dataset ID of an earlier run of this Actor. It re-audits the same pages and builds a before/after proof report. Example: YOUR_EARLIER_RUN_DATASET_ID"
          },
          "brandName": {
            "title": "White-label: your brand name",
            "type": "string",
            "description": "White-label: your agency or company name. When set, proof-report.html and proof-report.pdf show only your brand (no Lycorax branding). Example: Atlas SEO Agency"
          },
          "brandLogoUrl": {
            "title": "White-label: logo URL",
            "type": "string",
            "description": "White-label: https link to your logo (PNG or JPEG for the PDF; any image for the HTML report). Example: https://your-agency.com/logo.png"
          },
          "brandColor": {
            "title": "White-label: brand color",
            "pattern": "^$|^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$",
            "type": "string",
            "description": "White-label: hex color for the report. Example: #0b5fff"
          },
          "brandWebsite": {
            "title": "White-label: website (optional)",
            "type": "string",
            "description": "White-label: https link shown in the report footer. Example: https://your-agency.com"
          },
          "gscBeforeCsv": {
            "title": "Search Console export: BEFORE",
            "type": "string",
            "description": "Search Console proof: Performance → Export → Download CSV for the period before the fixes. Give the ZIP or Pages.csv/Queries.csv as a URL to the file, an Apify key-value store record (kv://STORE_ID/KEY or its api.apify.com record URL), or paste the CSV text. Example: kv://STORE_ID/gsc-before.zip"
          },
          "gscAfterCsv": {
            "title": "Search Console export: AFTER",
            "type": "string",
            "description": "Same Search Console export for the period after the fixes. Tip: filter both exports to Search type: Image to show Google Images traffic only. Example: kv://STORE_ID/gsc-after.zip"
          },
          "pagespeedApiKey": {
            "title": "Google PageSpeed API key (optional)",
            "type": "string",
            "description": "Optional: your own free Google Cloud PageSpeed Insights API key. Adds Google Lighthouse accessibility and SEO scores for the home page. Example format: AIza..."
          },
          "monitoring": {
            "title": "Monitoring: compare with the previous run",
            "type": "boolean",
            "description": "true = save a snapshot of this site in your named key-value store 'website-image-seo-monitor' and list new and fixed issues versus the previous monitoring run, with an alert summary. Pair it with a monthly Apify Schedule. Example: true",
            "default": false
          },
          "monitorKey": {
            "title": "Monitoring key (optional)",
            "type": "string",
            "description": "Optional name for the monitoring history. Defaults to the site address. Set it to keep separate histories for the same site (for example per client). Example: client-acme"
          },
          "generateCloudflareWorker": {
            "title": "Premium: generate a Cloudflare Worker that fixes alt text and missing SEO tags",
            "type": "boolean",
            "description": "true = generate a ready-to-paste Cloudflare Worker (free plan works) for a site proxied through Cloudflare. It fixes weak alt text and adds only missing tags (meta description, canonical, og:title, og:image, robots max-image-preview:large, Article/Product JSON-LD) from your own pages. Needs confirmAuthorized. Remove the route to roll back. Example: false",
            "default": false
          },
          "confirmAuthorized": {
            "title": "I own this site or am authorized to change it",
            "type": "boolean",
            "description": "Set to true only if you own this site or are authorized to change it. Required for generateCloudflareWorker. AI agents: ask the site owner before setting it. Example: true",
            "default": false
          },
          "workerIncludeReview": {
            "title": "Also include lower-confidence suggestions",
            "type": "boolean",
            "description": "For the Cloudflare Worker. false = only high and medium confidence fixes (from captions and titles). true = also include fixes marked for review. Example: false",
            "default": false
          },
          "maxFixes": {
            "title": "Max images to fix",
            "minimum": 1,
            "type": "integer",
            "description": "Upper limit of images fixed by the generated Worker. Example: 500",
            "default": 500
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}