{ "openapi": "3.0.1", "info": { "title": "Shopify AI Lead Generation Agent", "description": "Find sales-ready Shopify leads with public contact details, lead scores, pain points, and personalized outreach drafts.", "version": "0.1", "x-build-id": "DTa8g0QvGhZCI8PE3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xiaoyu-ai~ai-shopify-lead-generation-orchestrator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xiaoyu-ai-ai-shopify-lead-generation-orchestrator", "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/xiaoyu-ai~ai-shopify-lead-generation-orchestrator/runs": { "post": { "operationId": "runs-sync-xiaoyu-ai-ai-shopify-lead-generation-orchestrator", "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/xiaoyu-ai~ai-shopify-lead-generation-orchestrator/run-sync": { "post": { "operationId": "run-sync-xiaoyu-ai-ai-shopify-lead-generation-orchestrator", "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": [ "country", "niche", "limit", "icpPreset" ], "properties": { "country": { "title": "Country", "type": "string", "description": "Target country or market.", "default": "US" }, "niche": { "title": "Niche", "type": "string", "description": "Target Shopify merchant category, such as fitness, beauty, apparel, supplements, or home goods.", "default": "fitness" }, "limit": { "title": "Lead limit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of final leads to return.", "default": 100 }, "icpPreset": { "title": "ICP preset", "enum": [ "shopify_web_design_agency", "klaviyo_retention_agency", "cro_agency", "shopify_app_developer", "ecommerce_ads_agency", "custom" ], "type": "string", "description": "Choose the buyer profile that will use these leads. This tunes scoring, pain points, offer angles, and email drafts.", "default": "shopify_web_design_agency" }, "targetCustomer": { "title": "Your customer profile", "type": "string", "description": "Optional custom buyer profile. Leave blank to use the selected ICP preset.", "default": "" }, "startUrls": { "title": "Shopify store URLs", "type": "array", "description": "Optional list of Shopify store URLs to scan. Use this when the Shopify child Actor is a scanner rather than a discovery Actor.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeEmailDraft": { "title": "Generate email draft", "type": "boolean", "description": "Generate a first cold email draft for each qualified lead.", "default": true }, "minLeadScore": { "title": "Minimum lead score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only output leads with a score at or above this value.", "default": 60 }, "shopifyActorId": { "title": "Shopify Basic Info Actor ID", "type": "string", "description": "Actor ID for Shopify store discovery/basic info. Defaults to SHOPIFY_ACTOR_ID env var." }, "contactActorId": { "title": "Contact Extractor Actor ID", "type": "string", "description": "Actor ID for contact extraction. Defaults to CONTACT_ACTOR_ID env var." }, "toolsActorId": { "title": "AI Tools Directory Actor ID", "type": "string", "description": "Actor ID for AI tools directory context. Defaults to TOOLS_ACTOR_ID env var." }, "includeToolsDirectoryContext": { "title": "Include AI tools directory context", "type": "boolean", "description": "Run the AI Tools Directory Actor once and include a small context summary in RUN_REPORT. This is not per-store technology enrichment.", "default": false }, "toolsDirectoryStartUrls": { "title": "AI tools directory URLs", "type": "array", "description": "Directory URLs for the AI Tools Directory Actor.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxToolsDirectoryItems": { "title": "Max AI tools directory items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum AI tools directory records to fetch when context is enabled.", "default": 25 }, "openAiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Optional. If omitted, the Actor uses deterministic rule-based scoring and email drafts." }, "maxDiscoveryMultiplier": { "title": "Discovery multiplier", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many raw stores to request from discovery before filtering.", "default": 3 } } }, "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 } } } } } } } } } }