{ "openapi": "3.0.1", "info": { "title": "Lumirex-Online Footprint, LLM Visibility & Citation Audit Tool", "description": "Run AI brand audits, citation scans, and LLM visibility searches via the Lumirex platform. Outputs structured JSON for downstream analysis.", "version": "1.0", "x-build-id": "XYeAqn3XkWVHkFIzm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/netservices~lumirex-brand-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-netservices-lumirex-brand-audit", "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/netservices~lumirex-brand-audit/runs": { "post": { "operationId": "runs-sync-netservices-lumirex-brand-audit", "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/netservices~lumirex-brand-audit/run-sync": { "post": { "operationId": "run-sync-netservices-lumirex-brand-audit", "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": [ "lumirexApiKey", "mode", "brandName", "websiteUrl" ], "properties": { "lumirexApiKey": { "title": "Lumirex API Key", "type": "string", "description": "Your Lumirex API key (starts with lmx_). Generate one at https://lumirex.ai/settings under Developer / Integrations." }, "mode": { "title": "Mode", "enum": [ "citation-scan", "llm-visibility", "monitoring-setup" ], "type": "string", "description": "What to run: citation-scan (find NAP citations), llm-visibility (test AI brand visibility), or monitoring-setup (save recurring monitoring queries).", "default": "citation-scan" }, "brandName": { "title": "Brand Name", "type": "string", "description": "The business or brand name to audit." }, "websiteUrl": { "title": "Website URL", "type": "string", "description": "The business website URL (e.g. https://acme.com)." }, "citationScanType": { "title": "Citation Scan Type", "enum": [ "quick", "full" ], "type": "string", "description": "quick = indexed citations only (1 credit). full = indexed + non-indexed (3 credits). Only used in citation-scan mode.", "default": "quick" }, "aiVisibilityQueries": { "title": "AI Visibility Queries", "type": "array", "description": "Up to 5 custom questions to test brand visibility in ChatGPT, Claude, Gemini, and Perplexity. Only used in llm-visibility mode.", "default": [] }, "businessAddress": { "title": "Business Address", "type": "string", "description": "Full business address for NAP citation matching (e.g. 123 Main St, Tampa FL 33601)." }, "businessPhone": { "title": "Business Phone", "type": "string", "description": "Business phone number for NAP citation matching." }, "icpDescription": { "title": "Ideal Customer Profile", "type": "string", "description": "Describe your ideal customer to generate targeted AI visibility queries." }, "competitors": { "title": "Competitors", "type": "array", "description": "List of competitor names or URLs for competitive context.", "default": [] }, "monitoringInterval": { "title": "Monitoring Interval", "enum": [ "daily", "weekly", "monthly" ], "type": "string", "description": "How often to run monitoring queries. Only used in monitoring-setup mode.", "default": "weekly" }, "monitoringQueries": { "title": "Monitoring Queries", "type": "array", "description": "Up to 5 queries to monitor for brand visibility changes. Only used in monitoring-setup mode.", "default": [] }, "pollIntervalSeconds": { "title": "Poll Interval (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "How often to poll for audit completion (default: 10 seconds).", "default": 10 }, "maxPollAttempts": { "title": "Max Poll Attempts", "minimum": 10, "maximum": 120, "type": "integer", "description": "Maximum number of status polls before giving up (default: 60 = 10 minutes at 10s interval).", "default": 60 }, "lumirexBaseUrl": { "title": "Lumirex API Base URL", "type": "string", "description": "Override the Lumirex API base URL (leave blank to use https://lumirex.ai).", "default": "https://lumirex.ai" } } }, "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 } } } } } } } } } }