{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility & Citation Audit API", "description": "Audit how your brand and competitors appear in OpenAI and Claude web-search API answers. Capture mentions, citations, competitor gaps, cited domains, answer coverage, and inspectable evidence. BYOK. Only completed provider observations are billed", "version": "0.0", "x-build-id": "G3Mc3lIlBrR01SR7C" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/overbifrost~ai-brand-visibility-citation-audit-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-overbifrost-ai-brand-visibility-citation-audit-api", "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/overbifrost~ai-brand-visibility-citation-audit-api/runs": { "post": { "operationId": "runs-sync-overbifrost-ai-brand-visibility-citation-audit-api", "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/overbifrost~ai-brand-visibility-citation-audit-api/run-sync": { "post": { "operationId": "run-sync-overbifrost-ai-brand-visibility-citation-audit-api", "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": [ "target" ], "properties": { "prompts": { "title": "Prompts", "minItems": 1, "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Enter the exact questions you want the Actor to send to the selected provider APIs.", "items": { "type": "string" } }, "target": { "title": "Target brand", "required": [ "name" ], "type": "object", "description": "The brand or company to audit. Name is required; aliases and domains improve deterministic matching.", "properties": { "name": { "title": "Brand name", "type": "string", "description": "Canonical brand or company name.", "editor": "textfield", "minLength": 1, "maxLength": 200 }, "aliases": { "title": "Aliases", "type": "array", "description": "Optional alternative names, abbreviations, or spellings.", "editor": "stringList", "maxItems": 25, "uniqueItems": true, "placeholderValue": "e.g. Acme Inc." }, "domains": { "title": "Domains", "type": "array", "description": "Optional domains owned by the target, without paths.", "editor": "stringList", "maxItems": 25, "uniqueItems": true, "placeholderValue": "e.g. acme.com" } }, "additionalProperties": false }, "competitors": { "title": "Competitors", "maxItems": 25, "type": "array", "description": "Optional competitors to compare against. Add one card per competitor; the Actor does not discover competitors automatically.", "items": { "type": "object", "properties": { "name": { "title": "Competitor name", "type": "string", "description": "Canonical competitor name.", "editor": "textfield", "minLength": 1, "maxLength": 200 }, "aliases": { "title": "Aliases", "type": "array", "description": "Optional alternative names.", "editor": "stringList", "maxItems": 25, "uniqueItems": true, "placeholderValue": "e.g. Rival Inc." }, "domains": { "title": "Domains", "type": "array", "description": "Optional competitor domains.", "editor": "stringList", "maxItems": 25, "uniqueItems": true, "placeholderValue": "e.g. rival.com" } }, "required": [ "name" ], "additionalProperties": false } }, "surfaces": { "title": "AI providers", "minItems": 1, "maxItems": 5, "uniqueItems": true, "type": "array", "description": "Choose one or more launch providers for automated acquisition. These are API answer surfaces, not captured consumer-app sessions.", "items": { "type": "string", "enum": [ "OPENAI_SEARCH_API", "CLAUDE_WEB_SEARCH_API" ], "enumTitles": [ "OpenAI — web search API", "Anthropic Claude — web search API" ] } }, "scopes": { "title": "Location / language scopes", "maxItems": 25, "type": "array", "description": "Optional market context. Leave this empty to use each provider's default context. CiteGap reports requested scope separately from what the provider actually accepted or confirmed.", "items": { "type": "object", "properties": { "country": { "title": "Country code", "type": "string", "description": "Two-letter country code, for example US, NO or GB.", "editor": "textfield", "pattern": "^[A-Za-z]{2}$" }, "region": { "title": "Region", "type": "string", "description": "State, county or region where supported.", "editor": "textfield", "maxLength": 200 }, "city": { "title": "City", "type": "string", "description": "City where supported.", "editor": "textfield", "maxLength": 200 }, "timezone": { "title": "Timezone", "type": "string", "description": "IANA timezone where supported, for example Europe/Oslo.", "editor": "textfield", "maxLength": 100 }, "language": { "title": "Language", "type": "string", "description": "Language code where supported, for example en or nb.", "editor": "textfield", "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})?$" } }, "additionalProperties": false } }, "samplesPerObservation": { "title": "Repeated samples", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many independent API answers to collect for each prompt × surface × scope. Keep 1 for normal audits; higher values increase provider usage.", "default": 1 }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Required when OpenAI is selected. Create an API key in your OpenAI API account. The key is sent only to OpenAI and is never written to output or logs." }, "anthropicApiKey": { "title": "Anthropic API key", "type": "string", "description": "Required when Anthropic Claude is selected. Create an API key in the Anthropic Console. The key is sent only to Anthropic and is never written to output or logs." }, "geminiApiKey": { "title": "Gemini API key", "type": "string", "description": "Reserved for the Gemini adapter. Hidden from the public beta form while the Google-grounded commercial terms review remains open." }, "perplexityApiKey": { "title": "Perplexity API key", "type": "string", "description": "Reserved for Perplexity Agent API. The surface is currently gated, so the key is not needed for normal runs." }, "credentials": { "title": "Credentials object (API compatibility)", "type": "object", "description": "Programmatic alternative to the top-level secret fields. Hidden from the Console form; API callers may still supply it." }, "limits": { "title": "Run limits", "type": "object", "description": "Optional stricter safety caps. Most users should keep the built-in defaults.", "properties": { "maxObservations": { "title": "Maximum observations", "type": "integer", "description": "Stop planning after this many prompt × surface × scope × sample observations.", "editor": "number", "minimum": 1, "maximum": 500 }, "maxProviderRequests": { "title": "Maximum provider requests", "type": "integer", "description": "Stop before exceeding this many provider requests, including retries.", "editor": "number", "minimum": 1, "maximum": 500 }, "maxRetriesPerObservation": { "title": "Retries per observation", "type": "integer", "description": "Maximum retries after the first request. Authentication and quota errors are never retried.", "editor": "number", "minimum": 0, "maximum": 3 }, "maxDurationSeconds": { "title": "Maximum duration", "type": "integer", "description": "Programmatic safety deadline in seconds. Hidden in the Console because Apify Run timeout is the user-facing runtime control.", "editor": "hidden", "minimum": 1, "maximum": 3600, "unit": "seconds" }, "maxConcurrency": { "title": "Maximum concurrency", "type": "integer", "description": "Maximum number of observations processed at the same time.", "editor": "number", "minimum": 1, "maximum": 10 } }, "additionalProperties": false }, "captures": { "title": "Imported AI answers (advanced)", "maxItems": 500, "type": "array", "description": "Advanced JSON/API import path for already-observed consumer/public answers. Hidden from the normal Console form; this is not the standard CiteGap workflow.", "items": { "type": "object", "properties": { "prompt": { "title": "Prompt", "type": "string", "description": "The exact prompt that produced this answer.", "editor": "textfield", "minLength": 1, "maxLength": 4000 }, "answerSurface": { "title": "Observed answer surface", "type": "string", "description": "Select the exact consumer/public surface you copied the answer from. This is not treated as provider API output.", "editor": "select", "enum": [ "CHATGPT_CONSUMER", "GEMINI_CONSUMER", "PERPLEXITY_CONSUMER", "CLAUDE_CONSUMER", "COPILOT_CONSUMER", "GOOGLE_AI_MODE_PUBLIC", "GOOGLE_AI_OVERVIEWS_PUBLIC" ], "enumTitles": [ "ChatGPT consumer", "Gemini consumer", "Perplexity consumer", "Claude consumer", "Microsoft Copilot consumer", "Google AI Mode", "Google AI Overviews" ] }, "answerText": { "title": "AI answer", "type": "string", "description": "Paste the observed answer text.", "editor": "textarea", "minLength": 1, "maxLength": 100000 }, "citationUrls": { "title": "Citation URLs", "type": "array", "description": "Optional URLs visibly cited in the answer. Paste one URL per item. Leave empty if you did not capture citations.", "editor": "stringList", "maxItems": 200, "placeholderValue": "https://example.com/source" }, "answerComplete": { "title": "I copied the complete answer", "type": "boolean", "description": "Turn on only if the pasted text contains the entire observed answer. Off means absence findings from answer text are suppressed.", "default": false }, "citationsComplete": { "title": "I copied all visible citations", "type": "boolean", "description": "Turn on only if every visible citation/source was captured. Off means citation-absence findings are suppressed.", "default": false }, "observedAt": { "title": "Observed at", "type": "string", "description": "Optional ISO 8601 timestamp for when you observed the answer, for example 2026-09-28T09:30:00+02:00.", "editor": "textfield" } }, "required": [ "prompt", "answerSurface", "answerText" ], "additionalProperties": 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 } } } } } } } } } }