{ "openapi": "3.0.1", "info": { "title": "AI Search Visibility Action Plan", "description": "Check whether the AI search engines can fetch, read and cite your site, see what ChatGPT and Perplexity actually answer for your topics, and get a ranked fix list where every recommendation points at the evidence behind it. Pay per report.", "version": "0.1", "x-build-id": "ObHoogMacoXdp9TsB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gtm_solutions~ai-search-visibility-action-plan/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gtm_solutions-ai-search-visibility-action-plan", "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/gtm_solutions~ai-search-visibility-action-plan/runs": { "post": { "operationId": "runs-sync-gtm_solutions-ai-search-visibility-action-plan", "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/gtm_solutions~ai-search-visibility-action-plan/run-sync": { "post": { "operationId": "run-sync-gtm_solutions-ai-search-visibility-action-plan", "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": [ "domain", "brand" ], "properties": { "domain": { "title": "Domain", "type": "string", "description": "The site to check, as a hostname or URL (example.com or https://www.example.com). One domain per run." }, "brand": { "title": "Brand", "type": "string", "description": "The name the engines should mention, as customers write it." }, "aliases": { "title": "Aliases", "type": "array", "description": "Other spellings or short names that count as a mention (up to 5).", "default": [], "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Names to look for in the answers, optionally with a domain as name|domain (up to 5).", "default": [], "items": { "type": "string" } }, "topics": { "title": "Topics — what you want to be found for", "type": "array", "description": "What you want to be found for, e.g. 'CRM software for agencies' (up to 10). Leave empty and, with an engine key, we read your homepage and choose them for you.", "default": [], "items": { "type": "string" } }, "suggestOnly": { "title": "Just suggest topics — don't run the report yet", "type": "boolean", "description": "Reads your homepage, writes the topics we would ask about, and stops. No report is charged; a key you give makes one small call. Paste the ones you want into Topics and run the report.", "default": false }, "locations": { "title": "Locations", "type": "array", "description": "Places added to the questions made from topics you typed, e.g. 'Taipei' (up to 3). Not used when topics are chosen for you.", "default": [], "items": { "type": "string" } }, "prompts": { "title": "Prompts", "type": "array", "description": "Questions to ask the engines. Leave empty to generate them from the topics. 20 are included in the report price; each prompt above 20 is an extraPrompts event; 100 at most.", "default": [], "items": { "type": "string" } }, "pages": { "title": "Pages", "type": "array", "description": "Pages on the domain to check besides the homepage (up to 10). Leave empty to use the first five sitemap URLs.", "default": [], "items": { "type": "string" } }, "modelTier": { "title": "Which AI models to ask", "enum": [ "quick", "standard", "deep" ], "type": "string", "description": "Quick asks the engines' cheapest models (a first look). Standard asks the models closest to what the ChatGPT and Perplexity apps show most people. Deep asks their strongest models. One report asks one tier; run another report to compare.", "default": "standard" }, "perplexityApiKey": { "title": "Perplexity API key", "type": "string", "description": "Queries Perplexity with your key. Stored as a secret; never written to the output." }, "perplexityModel": { "title": "Perplexity model", "type": "string", "description": "Developers only (API): a specific Perplexity preset or model id that overrides the dropdown for this engine. Empty means the dropdown decides. Not shown on the form." }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Queries OpenAI (Responses API with web search) with your key. Stored as a secret; never written to the output." }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "Developers only (API): a specific OpenAI model id that overrides the dropdown for this engine. Empty means the dropdown decides. Not shown on the form." }, "includeEvidence": { "title": "Include evidence excerpts", "type": "boolean", "description": "Include short page and answer excerpts (up to 400 characters each) in the output.", "default": true }, "managed": { "title": "Managed mode", "type": "boolean", "description": "Operator-only: query the engines on the operator's keys. Refused unless enabled on the Actor's environment.", "default": false } } }, "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 } } } } } } } } } }