{ "openapi": "3.0.1", "info": { "title": "AI Visibility Check — Cited by ChatGPT, Perplexity & Gemini?", "description": "Live check across ChatGPT, Perplexity, Claude & Gemini: which buyer queries cite your brand, which ignore you, and who gets cited instead. Real citations, not training-data guesses. Free tier + $3 flat.", "version": "0.1", "x-build-id": "BXsPuz2ySIrasJjSo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sorcerai~constellation-ai-visibility-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sorcerai-constellation-ai-visibility-check", "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/sorcerai~constellation-ai-visibility-check/runs": { "post": { "operationId": "runs-sync-sorcerai-constellation-ai-visibility-check", "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/sorcerai~constellation-ai-visibility-check/run-sync": { "post": { "operationId": "run-sync-sorcerai-constellation-ai-visibility-check", "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": [ "url" ], "properties": { "url": { "title": "Your website URL", "type": "string", "description": "Website to check, e.g. https://example.com. Must contain a valid domain; the registrable domain is what citation matching runs against." }, "brand": { "title": "Brand name (optional)", "type": "string", "description": "Brand name to detect in AI answers. If empty, derived from the domain (e.g. 'stripe.com' → 'Stripe'). Set this when your brand differs from your domain name." }, "queries": { "title": "Search queries (optional)", "type": "array", "description": "Buyer-style queries to test, e.g. 'best invoicing software'. Free tier uses the first 1, full tier the first 5. If empty, sensible queries are auto-generated from the brand ('best X', 'X alternatives', 'X review', ...).", "items": { "type": "string" } }, "engines": { "title": "AI engines to check", "type": "array", "description": "Engines to query on the full tier. Allowed values: perplexity, chat_gpt, claude, gemini. Defaults to all four. The free tier always uses perplexity only.", "items": { "type": "string" }, "default": [ "perplexity", "chat_gpt", "claude", "gemini" ] }, "reps": { "title": "Repetitions per query", "minimum": 1, "maximum": 2, "type": "integer", "description": "How many times each query is asked per engine (AI answers vary between runs; 2 reps gives more reliable citation detection). Free tier is fixed at 1; full tier allows up to 2.", "default": 2 }, "aliases": { "title": "Brand aliases (optional)", "type": "array", "description": "Alternative names the AI might use for your brand (e.g. 'HubSpot CRM' for 'HubSpot'). Counted as mentions when detected in answers.", "items": { "type": "string" } }, "tier": { "title": "Check tier", "enum": [ "free", "full" ], "type": "string", "description": "free ($0): 1 query, 1 engine (Perplexity), 1 rep — a quick taste, daily limit applies. full ($3 flat, pay-per-event): 5 queries × 4 engines × 2 reps, complete per-engine and per-query report with Domain Rating. Charged only on successful delivery; failed or partial runs are never billed.", "default": "free" } } }, "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 } } } } } } } } } }