{ "openapi": "3.0.1", "info": { "title": "AI Company Enrichment - Website to Firmographics", "description": "Turn a list of company websites into clean firmographics: industry, what they sell, who they sell to, size band, pricing model, contacts, socials, tech hints. One LLM-verified JSON record per company, every judgment with evidence.", "version": "0.1", "x-build-id": "TVeOflDqPWGLxeAXW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ceo.sss~ai-company-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ceo.sss-ai-company-enrichment", "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/ceo.sss~ai-company-enrichment/runs": { "post": { "operationId": "runs-sync-ceo.sss-ai-company-enrichment", "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/ceo.sss~ai-company-enrichment/run-sync": { "post": { "operationId": "run-sync-ceo.sss-ai-company-enrichment", "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", "properties": { "websites": { "title": "Company websites", "type": "array", "description": "One homepage URL or domain per line (https:// is added if missing). Each becomes one enriched row.", "items": { "type": "string" } }, "companyNames": { "title": "Company names (optional)", "type": "array", "description": "Names without a known website. Best effort: the homepage is resolved via a DuckDuckGo search for \" official website\"; check the resolved URL in the output. Prefer websites[] when you have them.", "items": { "type": "string" } }, "pagesToCrawl": { "title": "Pages per company", "minimum": 1, "maximum": 8, "type": "integer", "description": "Homepage plus up to this many minus one of: about, pricing, careers, contact, blog (in that priority). robots.txt is respected.", "default": 6 }, "maxItems": { "title": "Max companies", "minimum": 1, "type": "integer", "description": "Stop after this many companies (after dedupe). Leave empty for all." }, "includeRawText": { "title": "Include raw page text", "type": "boolean", "description": "Attach the extracted text of every fetched page to the row (large). Useful for auditing the LLM's answers.", "default": false }, "llmProvider": { "title": "LLM provider", "enum": [ "apify-managed", "byok" ], "type": "string", "description": "Managed: the actor's own OpenAI-compatible key, LLM cost is included in the per-company price. BYOK: your key, your bill; the per-company price still applies.", "default": "apify-managed" }, "openaiApiKey": { "title": "OpenAI-compatible API key (BYOK)", "type": "string", "description": "Only used when llmProvider = byok. Works with OpenAI, Azure OpenAI (v1 endpoint), OpenRouter, Groq, Together, Ollama... anything speaking /v1/chat/completions with response_format json_object." }, "openaiBaseUrl": { "title": "Base URL (BYOK)", "type": "string", "description": "Default https://api.openai.com/v1. For Azure: https://.openai.azure.com/openai/v1. For OpenRouter: https://openrouter.ai/api/v1." }, "model": { "title": "Model", "type": "string", "description": "Chat model name. Must support JSON output. In managed mode the operator's default may override this.", "default": "gpt-4o-mini" }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Companies processed in parallel. Each company's pages are fetched one after another.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy by default. Residential helps for sites that block datacenter IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } } } }, "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 } } } } } } } } } }