{
  "openapi": "3.0.1",
  "info": {
    "title": "Keyword Research Tool: Volume, CPC, Fan-out, FAQ & GEO",
    "description": "Keyword research at scale: expand one seed into hundreds of keyword ideas with real Google search volume, CPC and competition, an opportunity score, and AI-Overview (GEO) flags. Includes People Also Ask, clustering, and paste-ready FAQ + FAQPage schema for SEO and generative-engine content.",
    "version": "0.0",
    "x-build-id": "yPo3CNbMboOKay3mR"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/aitorsm~keyword-fanout/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-aitorsm-keyword-fanout",
        "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/aitorsm~keyword-fanout/runs": {
      "post": {
        "operationId": "runs-sync-aitorsm-keyword-fanout",
        "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/aitorsm~keyword-fanout/run-sync": {
      "post": {
        "operationId": "run-sync-aitorsm-keyword-fanout",
        "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": {
          "seeds": {
            "title": "Seed keywords",
            "type": "array",
            "description": "One or more seed keywords/phrases to expand. Each is fanned out into hundreds of real search queries. Tip: feed several SPECIFIC seeds (e.g. \"eventbrite api\", \"event organizer contact list\") rather than one broad phrase — vague seeds pull off-topic drift.",
            "items": {
              "type": "string"
            }
          },
          "seedUrls": {
            "title": "Seed URLs (auto-extract seeds from a page)",
            "type": "array",
            "description": "Optional. Give a page URL and the actor reads its title / H1 / meta keywords and uses them as seeds — 'optimize THIS page' without hand-picking keywords.",
            "items": {
              "type": "string"
            }
          },
          "sources": {
            "title": "Search engines",
            "type": "array",
            "description": "Which autocomplete engines to fan out across. Google = web intent, YouTube = how-to/tutorial intent, Bing = alternate commercial phrasing. Using several broadens coverage and de-duplicates automatically.",
            "items": {
              "type": "string",
              "enum": [
                "google",
                "youtube",
                "bing"
              ],
              "enumTitles": [
                "Google",
                "YouTube",
                "Bing"
              ]
            },
            "default": [
              "google"
            ]
          },
          "regions": {
            "title": "Regions / locales",
            "type": "array",
            "description": "Fan out per market. Use country codes (us, gb, es, mx, de, fr, br…) or explicit hl-gl locales (en-us, es-mx). Empty = single language set by 'Language' below. Each keyword is tagged with the region(s) that surfaced it.",
            "items": {
              "type": "string"
            }
          },
          "language": {
            "title": "Language (used when no regions given)",
            "type": "string",
            "description": "Autocomplete language code (hl) when 'Regions' is empty, e.g. en, es, fr, de.",
            "default": "en"
          },
          "includeAlphabet": {
            "title": "Alphabet expansion (seed + a…z)",
            "type": "boolean",
            "description": "Append each letter a–z to grow the long-tail. Biggest source of variety.",
            "default": true
          },
          "includeQuestions": {
            "title": "Question expansion (how/what/is…)",
            "type": "boolean",
            "description": "Prefix question words to surface FAQ-ready queries.",
            "default": true
          },
          "includeSuffixes": {
            "title": "Intent-suffix expansion (api/tool/free…)",
            "type": "boolean",
            "description": "Append commercial-intent suffixes to surface high-intent variants.",
            "default": true
          },
          "customModifiers": {
            "title": "Custom modifiers",
            "type": "array",
            "description": "Extra words applied as BOTH prefix and suffix to every seed (e.g. \"london\", \"2026\", \"cheap\").",
            "items": {
              "type": "string"
            }
          },
          "depth": {
            "title": "Expansion depth",
            "minimum": 1,
            "maximum": 2,
            "type": "integer",
            "description": "1 = expand the seeds only. 2 = also re-expand the top discovered keywords (recursive), for much deeper long-tail coverage.",
            "default": 1
          },
          "subSeedsPerSeed": {
            "title": "Sub-seeds per seed (depth 2)",
            "minimum": 1,
            "maximum": 25,
            "type": "integer",
            "description": "How many top discovered keywords to re-expand when depth = 2.",
            "default": 5
          },
          "maxKeywordsPerSeed": {
            "title": "Max keywords per seed",
            "minimum": 0,
            "type": "integer",
            "description": "Cap the output per seed (0 = unlimited). Keeps the most prominent keywords first.",
            "default": 0
          },
          "maxProbes": {
            "title": "Max probes (safety cap)",
            "minimum": 50,
            "type": "integer",
            "description": "Hard ceiling on total autocomplete requests, to bound cost/time on big seed × source × region grids.",
            "default": 6000
          },
          "cluster": {
            "title": "Cluster near-duplicates",
            "type": "boolean",
            "description": "Group reworded variants of the same query and flag one representative, so your FAQ isn't five versions of one question.",
            "default": true
          },
          "generateArtifact": {
            "title": "Generate paste-ready FAQ artifacts",
            "type": "boolean",
            "description": "Write FAQ.md, a schema.org FAQPage JSON-LD file, and SUMMARY.md to the key-value store — ready to drop into a page.",
            "default": true
          },
          "serpEnrich": {
            "title": "Add Google 'People also ask' + related searches ($)",
            "type": "boolean",
            "description": "Pull Google's real 'People also ask' questions and 'Related searches' via the Google Search Results Scraper. The highest-quality question source. Adds that actor's per-page cost.",
            "default": false
          },
          "serpActorId": {
            "title": "SERP actor",
            "type": "string",
            "description": "Actor used for PAA / related searches.",
            "default": "apify/google-search-scraper"
          },
          "serpMaxQueries": {
            "title": "Max SERP queries",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many queries (seeds + top questions) to send to the SERP actor. Controls SERP cost.",
            "default": 10
          },
          "serpCountryCode": {
            "title": "SERP country code",
            "type": "string",
            "description": "Two-letter country for the SERP search (defaults to the first region's country)."
          },
          "enrichVolume": {
            "title": "Enrich with real search volume ($)",
            "type": "boolean",
            "description": "After discovery, attach real monthly search volume + CPC + competition to every keyword via the Keyword Search Volume actor. Adds that actor's cost.",
            "default": false
          },
          "volumeActorId": {
            "title": "Volume actor",
            "type": "string",
            "description": "Primary actor to call for volume enrichment.",
            "default": "aitorsm/keyword-volume"
          },
          "volumeFallbackActorId": {
            "title": "Volume fallback actor ($)",
            "type": "string",
            "description": "Called only when the primary volume actor returns no data (e.g. before Google Ads credentials are wired). Third-party, charged per keyword batch. Set empty to disable.",
            "default": "iskander/google-keyword-search-volume-api"
          },
          "volumeGeo": {
            "title": "Volume geo",
            "type": "string",
            "description": "Country code/name or geoTargetConstant id passed to the volume actor."
          },
          "volumeLanguage": {
            "title": "Volume language",
            "type": "string",
            "description": "Language code/name or languageConstant id passed to the volume actor."
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Parallel autocomplete probes. Lower it if you hit rate-limits on large runs.",
            "default": 8
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional proxy. Autocomplete works from datacenter IPs; add a proxy only if you hit rate-limits at scale."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}