{ "openapi": "3.0.1", "info": { "title": "B2B Company Data Enrichment & Completion", "description": "Complete missing company data from public sources. Add business emails, phones and company social profiles to existing records without re-enriching fields you already have. Built for CSV, API, AI agent and MCP workflows.", "version": "1.0", "x-build-id": "epbww8Ec77cVtx7Xp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/akatra~b2b-data-completion-agent/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-akatra-b2b-data-completion-agent", "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/akatra~b2b-data-completion-agent/runs": { "post": { "operationId": "runs-sync-akatra-b2b-data-completion-agent", "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/akatra~b2b-data-completion-agent/run-sync": { "post": { "operationId": "run-sync-akatra-b2b-data-completion-agent", "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": [ "requiredFields" ], "properties": { "sourceMode": { "title": "Where are your records?", "enum": [ "records", "dataset" ], "type": "string", "description": "'records' reads the list below. 'dataset' reads an existing Apify dataset you select. Your dataset is only ever read, never changed.", "default": "records" }, "records": { "title": "Company records", "type": "array", "description": "Used when the source is 'records'. A list of objects. Useful keys: recordId (or id), companyName, website or domain, businessEmail, businessPhone, address, linkedinCompany, instagram, facebook, x, youtube. Other keys are echoed in the output under 'original'; person-like keys and values (names, job titles, personal emails, personal LinkedIn profiles, mobile numbers) are removed. Akatra only completes company-level public data." }, "sourceDataset": { "title": "Source dataset", "type": "string", "description": "Used when the source is 'dataset'. Read-only access." }, "requiredFields": { "title": "Fields you need", "type": "array", "description": "The data contract. A field counts as done only when it is present and valid, not merely non-empty. Akatra works only on fields that are not done and stops when all are. It can complete businessEmail, businessPhone, linkedinCompany, instagram, facebook, x and youtube from the company's public website; address can be required and checked but is not extracted in V1.", "items": { "type": "string", "enum": [ "companyName", "domain", "website", "businessEmail", "businessPhone", "address", "linkedinCompany", "instagram", "facebook", "x", "youtube" ], "enumTitles": [ "Company name", "Domain", "Website", "Business email", "Business phone", "Address", "LinkedIn company page", "Instagram", "Facebook", "X (Twitter)", "YouTube" ] } }, "emailVerification": { "title": "Email verification", "enum": [ "not_required", "verified_if_possible", "verified_required" ], "type": "string", "description": "'not_required' skips verification. 'verified_if_possible' verifies when a verifier is available. 'verified_required' keeps a business email unresolved until mailbox-level verification succeeds. Without a mailbox-level verifier an email is reported as mx_only at best, never verified.", "default": "not_required" }, "maxBudgetUsd": { "title": "Maximum external provider spend (USD)", "minimum": 0, "type": "number", "description": "Optional ceiling on estimated spend with external providers. Internal work is not counted. Leave empty for no extra ceiling beyond your Apify run limit." }, "maxRecords": { "title": "Maximum records to process", "minimum": 1, "type": "integer", "description": "Optional. Process only the first N records." }, "maxProviderAttempts": { "title": "Maximum attempts per field", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many providers may be tried for one missing field before it is reported as unresolved.", "default": 3 }, "providerStrategy": { "title": "Provider strategy", "enum": [ "internal_first", "internal_only" ], "type": "string", "description": "'internal_first' completes records with Akatra's own website reader and uses an approved external provider only as a fallback when one is available and affordable. 'internal_only' never calls an external provider.", "default": "internal_first" }, "includeProvenance": { "title": "Include provenance", "type": "boolean", "description": "Attach, for every value Akatra found, the method, source page, attempt and time.", "default": true }, "maxPagesPerWebsite": { "title": "Maximum pages per website", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many public pages (home, contact, about, imprint) may be read per company website.", "default": 5 }, "maxConcurrency": { "title": "Maximum concurrent websites", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many company websites are read at the same time.", "default": 10 } } }, "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 } } } } } } } } } }