{ "openapi": "3.0.1", "info": { "title": "Firecrawl Enrich - Data Enrichment", "description": "Enrich business data with Firecrawl. Get company info, contact details, social profiles & website data. Batch process leads for sales & marketing.", "version": "1.0", "x-build-id": "0Et5lbfidRl5TWFMm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~fire-enrich/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-fire-enrich", "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/alizarin_refrigerator-owner~fire-enrich/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-fire-enrich", "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/alizarin_refrigerator-owner~fire-enrich/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-fire-enrich", "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": { "leads": { "title": "Leads to Enrich", "type": "array", "description": "Array of leads to enrich. Each lead should have at minimum a company name or website.", "items": { "type": "object", "properties": { "companyName": { "type": "string", "title": "Company Name", "description": "The company name to enrich" }, "website": { "type": "string", "title": "Website URL", "description": "The company website URL" }, "email": { "type": "string", "title": "Email", "description": "Contact email address" }, "linkedinUrl": { "type": "string", "title": "LinkedIn URL", "description": "LinkedIn company or profile URL" }, "city": { "type": "string", "title": "City", "description": "City location" }, "state": { "type": "string", "title": "State", "description": "State/region location" } } } }, "customFields": { "title": "Custom Fields to Extract", "type": "array", "description": "Custom fields for the AI to extract. Each field has a name and description.", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Field Name", "description": "Field name (e.g., 'hasEcommerce')" }, "description": { "type": "string", "title": "Field Description", "description": "What to look for (e.g., 'Does the company sell products online?')" } } }, "default": [] }, "agents": { "title": "Agents to Run", "type": "array", "description": "Which enrichment agents to run (in order)", "items": { "type": "string", "enum": [ "discovery", "company_profile", "financial_intel", "tech_stack", "custom_fields" ] }, "default": [ "discovery", "company_profile", "financial_intel", "tech_stack" ] }, "firecrawlApiKey": { "title": "Firecrawl API Key", "type": "string", "description": "Your Firecrawl API key for web scraping" }, "anthropicApiKey": { "title": "Anthropic API Key", "type": "string", "description": "Your Anthropic API key for Claude AI" }, "openaiApiKey": { "title": "OpenAI API Key (Fallback)", "type": "string", "description": "Optional OpenAI API key as fallback if Claude fails" }, "maxConcurrency": { "title": "Max Concurrent Enrichments", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of leads to enrich in parallel", "default": 3 }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data (no API keys required). Set to false and provide your API keys for real enrichment.", "default": true }, "useAgentMode": { "title": "Use Firecrawl Agent Mode", "type": "boolean", "description": "Enable autonomous navigation using Firecrawl Agent API. When enabled, the agent will navigate to About, Pricing, Careers, and other pages to find accurate data instead of just scraping the homepage. Requires Firecrawl API key.", "default": true }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional: URL to receive webhook notifications when enrichment completes. Results will be POSTed as JSON." } } }, "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 } } } } } } } } } }