{ "openapi": "3.0.1", "info": { "title": "Website Contact & Company Data Scraper with AI Lead Scoring", "description": "Crawl company domains for emails, phones, and socials, then add an AI company profile and ICP fit score. Flat price per domain, not per page.", "version": "0.1", "x-build-id": "QEA3oKPpDPqteX3oK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/craftedincode~website-company-profile-ai/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-craftedincode-website-company-profile-ai", "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/craftedincode~website-company-profile-ai/runs": { "post": { "operationId": "runs-sync-craftedincode-website-company-profile-ai", "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/craftedincode~website-company-profile-ai/run-sync": { "post": { "operationId": "run-sync-craftedincode-website-company-profile-ai", "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": { "domains": { "title": "Company domains or URLs", "type": "array", "description": "Company domains or page URLs, one per line. https:// is optional. Duplicates of the same domain are crawled once.", "items": { "type": "string" } }, "datasetId": { "title": "Source dataset", "type": "string", "description": "Optional Apify dataset, for example the output of a Google Maps scraper. The Actor reads the website field and keeps the original columns on each row." }, "websiteField": { "title": "Website field name", "type": "string", "description": "Column that holds the company website. Also checks website, websiteUrl, domain, url, and web. Google Maps links are ignored.", "default": "website" }, "maxDomains": { "title": "Max domains", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard stop. The Actor will not crawl more domains than this, even if the charge limit would allow it.", "default": 100 }, "maxPagesPerDomain": { "title": "Max pages per domain", "minimum": 1, "maximum": 8, "type": "integer", "description": "Homepage plus contact, about, team, careers, and legal pages, up to this many fetches. Capped at 8 so the flat domain price stays predictable.", "default": 5 }, "maxChargeUsd": { "title": "Max charge (USD)", "minimum": 0, "type": "number", "description": "Optional extra ceiling for this run, in USD. It is applied together with the run's maximum charge in the Console (the lower one wins). Leave empty to use only the Console limit. Dead, parked, and blocked domains are not charged." }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many domains to crawl at once. Lower is more polite.", "default": 5 }, "includePersonalEmails": { "title": "Include personal emails", "type": "boolean", "description": "Off by default. Role inboxes such as info@ and sales@ are always kept. Named addresses such as jane.doe@ are personal data and are omitted unless you turn this on. You are responsible for lawful use.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional Apify proxy. Datacenter is enough for most sites. The RESIDENTIAL group is ignored here because residential traffic is billed to the Actor developer; a capped fallback can be enabled by the developer as a secret." }, "aiEnrichment": { "title": "AI company profile", "type": "boolean", "description": "Add a summary, industry, what they sell, a size signal, and an ICP fit score. This is a separate charge from the crawl. Free-plan runs are limited to 25 AI profiles per run and 100 per UTC month.", "default": true }, "icpDescription": { "title": "Ideal customer profile", "type": "string", "description": "Plain English description of who you sell to. The fit score is judged against this text. Leave empty and the score is left blank.", "default": "" }, "aiLanguage": { "title": "AI output language", "type": "string", "description": "Language for the summary and outreach line. Use a short code such as en or de.", "default": "en" }, "maxAiDomains": { "title": "Max AI profiles", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Upper bound on AI profiles this run may create. Free-plan runs are still capped at 25 per run and 100 per month.", "default": 1000 } } }, "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 } } } } } } } } } }