{ "openapi": "3.0.1", "info": { "title": "AI Visibility Prompt Research & Panel Builder", "description": "Discover and prioritize buyer questions into reusable, versioned prompt panels for AI visibility tracking and generative engine optimization (GEO).", "version": "0.0", "x-build-id": "SVeCA1Ng6sshqsLXf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aitorsm~geo-prompt-research/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aitorsm-geo-prompt-research", "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~geo-prompt-research/runs": { "post": { "operationId": "runs-sync-aitorsm-geo-prompt-research", "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~geo-prompt-research/run-sync": { "post": { "operationId": "run-sync-aitorsm-geo-prompt-research", "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": [ "seeds" ], "properties": { "seeds": { "title": "Seed topics", "minItems": 1, "maxItems": 25, "uniqueItems": true, "type": "array", "description": "Required topic or category phrases. Empty input is rejected before research begins.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "brandName": { "title": "Brand / product name (optional)", "maxLength": 200, "type": "string", "description": "Display/discovery context only; never fetched." }, "brandDomain": { "title": "Brand domain (optional)", "maxLength": 253, "type": "string", "description": "Display metadata only; never fetched." }, "country": { "title": "Country", "pattern": "^$|^[A-Za-z]{2}$", "maxLength": 2, "type": "string", "description": "Two-letter country code. Omit or leave blank for worldwide." }, "language": { "title": "Language", "pattern": "^$|^[A-Za-z]{2}$", "maxLength": 2, "type": "string", "description": "Two-letter language code.", "default": "en" }, "audiencePersona": { "title": "Audience / persona (optional)", "maxLength": 500, "type": "string", "description": "Audience context appended to generated prompts." }, "includeTerms": { "title": "Include terms (optional)", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Keep candidates containing at least one term.", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "excludeTerms": { "title": "Exclude terms (optional)", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Drop candidates containing any term.", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "intents": { "title": "Intent categories (optional)", "maxItems": 5, "uniqueItems": true, "type": "array", "description": "Restrict the panel to selected intents; empty means all.", "items": { "type": "string", "enum": [ "informational", "comparison", "commercial", "troubleshooting", "evaluation" ], "enumTitles": [ "Informational", "Comparison", "Commercial", "Troubleshooting", "Evaluation" ] } }, "maxPrompts": { "title": "Max prompts in the panel", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on charged, delivered prompts.", "default": 20 }, "enrichDemand": { "title": "Enrich with real search demand ($)", "type": "boolean", "description": "Add available search volume, CPC, and competition. Missing data remains null.", "default": false }, "maxCostUsd": { "title": "Research budget guard (USD, optional)", "minimum": 0, "maximum": 1000, "type": "number", "description": "Limits the size of this research run under the published cost assumptions. Zero returns an empty structured panel; omit for the standard limits." }, "maxRuntimeSecs": { "title": "Max runtime budget (seconds, optional)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Stops research within the selected time budget while leaving time to save available results.", "default": 300 }, "deterministic": { "title": "Limit to focused discovery", "type": "boolean", "description": "Leave this off for broad coverage (recommended), including A-Z keyword expansions. Turn it on only for a smaller, faster research sweep.", "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 } } } } } } } } } }