{ "openapi": "3.0.1", "info": { "title": "ChatGPT Search Visibility Tracker: Brand Mentions (API)", "version": "0.1", "x-build-id": "d0SHLfDEx0F5T7rhL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/venture_ace~chatgpt-search-visibility/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-venture_ace-chatgpt-search-visibility", "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/venture_ace~chatgpt-search-visibility/runs": { "post": { "operationId": "runs-sync-venture_ace-chatgpt-search-visibility", "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/venture_ace~chatgpt-search-visibility/run-sync": { "post": { "operationId": "run-sync-venture_ace-chatgpt-search-visibility", "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": [ "prompts", "brands" ], "properties": { "openaiApiKey": { "title": "OpenAI API key (yours)", "type": "string", "description": "Your own OpenAI API key. It is sent only to api.openai.com, is never written to the results or the log, and OpenAI bills you directly for the searches and tokens (web search is billed per call by OpenAI). Without a key the run stops and makes no call. Without a key the run ends with one input_error row and makes no call." }, "prompts": { "title": "Prompts (questions to ask)", "type": "array", "description": "One question per line, as a customer would type it, for example 'best CRM for a small plumbing business'. Duplicates are dropped. Each prompt is one OpenAI web-search call.", "items": { "type": "string" } }, "brands": { "title": "Brands or domains to look for", "type": "array", "description": "Brand names ('Acme') and/or domains ('acme.com'). A name counts as mentioned when it appears as a whole word in the answer text (case-insensitive). A domain counts as mentioned when its name part (acme for acme.com) or the full domain appears as a whole word in the text, and as cited when a cited URL is on that domain or a subdomain. Put competitors here too to compare.", "items": { "type": "string" } }, "maxPrompts": { "title": "Max prompts per run", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap on prompts sent in this run; extra prompts are ignored with a log line.", "default": 50 }, "model": { "title": "OpenAI model", "type": "string", "description": "Any model your key can use with the Responses API web search tool. Cheaper models cost you less per prompt at OpenAI.", "default": "gpt-4.1-mini" }, "country": { "title": "Search country (optional)", "type": "string", "description": "Two-letter country code (for example AU, US, GB) passed as the approximate search location. Leave empty for no location." }, "searchContextSize": { "title": "Search context size", "enum": [ "low", "medium", "high" ], "type": "string", "description": "How much web content the search tool feeds the model. Higher costs you more at OpenAI.", "default": "medium" } } }, "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 } } } } } } } } } }