Lead Generation Command

Creates a command object to generate qualified sales leads for your business based on target audience criteria, product offerings, and business goals.

Endpoint


POST /api/agents/sales/leadGeneration

You can also use the standardized agent command format:


POST /api/agents/sales/command/leadGeneration

Request Body

Parameter	Type	Required	Description
`siteId`	string	Yes	ID of the website to generate leads for
`userId`	string	No	ID of the user requesting lead generation
`agent_id`	string	No	ID of the agent to handle lead generation
`leadGenData`	object	Yes	Object containing all lead generation parameters
`maxLeads`	number	No	Maximum number of leads to generate (default: 10)
`priority`	string	No	Priority of lead generation job (“high”, “medium”, “low”)

leadGenData Object

Parameter	Type	Required	Description
`targetAudience`	object	Yes	Information about the target audience
`searchCriteria`	object	No	Specific criteria to use in lead search
`productOffering`	object	No	Product or service information relevant to leads
`businessInfo`	object	No	Information about your business for lead matching

targetAudience Object

Parameter	Type	Required	Description
`industries`	array	No	Target industries (e.g., [“software”, “healthcare”])
`companySize`	array	No	Target company sizes (e.g., [“10-50”, “51-200”])
`roles`	array	No	Target job roles (e.g., [“CTO”, “VP of Engineering”])
`locations`	array	No	Target geographic locations
`interests`	array	No	Specific interests or needs of target audience

Example Request


{
  "siteId": "site_456abc",
  "userId": "user_123xyz",
  "agent_id": "agent_sales_789def",
  "leadGenData": {
    "targetAudience": {
      "industries": ["saas", "tech", "manufacturing"],
      "companySize": ["51-200", "201-500"],
      "roles": ["CTO", "Head of Engineering", "VP of Operations"],
      "locations": ["United States", "Canada", "United Kingdom"],
      "interests": ["automation", "efficiency", "cost-reduction"]
    },
    "searchCriteria": {
      "keywords": ["digital transformation", "workflow automation"],
      "excludedTerms": ["recruiting", "staffing"],
      "minRevenueUSD": 1000000,
      "maxRevenueUSD": 50000000,
      "hasWebsite": true
    },
    "productOffering": {
      "name": "Workflow Automation Platform",
      "primaryValue": "Reduce manual processes by 60%",
      "idealCustomerProfile": "Mid-sized manufacturing companies struggling with outdated processes"
    },
    "businessInfo": {
      "name": "Acme Automation Inc.",
      "industry": "enterprise software",
      "uniqueSellingPoints": [
        "Industry-specific automation templates",
        "30-day implementation guarantee",
        "24/7 customer support"
      ]
    }
  },
  "maxLeads": 25,
  "priority": "high"
}

Try It

Lead Generation API Tester

Use this tester to generate qualified sales leads with different parameters and see the results.

You can test this API directly using our API Tester interface. The Sales API tester allows you to generate leads with different parameters and see the results.

Required fields:

Site ID: The ID of the website to generate leads for
Website URL: URL of the site to analyze for lead generation

Optional fields:

Agent ID: The ID of the agent to handle lead generation
Lead Capture Mechanism: How leads will be captured (form, chatbot, etc.)
Max Generation Count: Maximum number of items to generate
Priority: Priority level for this job (high, medium, low)

The API Tester makes it easy to see example requests in various programming languages and test the endpoint directly.

Generated Command Structure

The system generates a command object with the following structure to control the lead generation process:


{
  "task": "generate qualified sales leads",
  "userId": "user_123xyz",
  "agentId": "agent_sales_789def",
  "site_id": "site_456abc",
  "description": "Generate 25 qualified leads for Acme Automation Inc.'s Workflow Automation Platform, targeting CTOs and VPs in mid-sized manufacturing companies in North America and the UK interested in digital transformation.",
  "targets": [
    {
      "leads": {
        "count": 25,
        "profile": {
          "industries": ["saas", "tech", "manufacturing"],
          "company_sizes": ["51-200", "201-500"],
          "roles": ["CTO", "Head of Engineering", "VP of Operations"],
          "locations": ["United States", "Canada", "United Kingdom"],
          "interests": ["automation", "efficiency", "cost-reduction"]
        },
        "search_parameters": {
          "keywords": ["digital transformation", "workflow automation"],
          "excluded_terms": ["recruiting", "staffing"],
          "revenue_range": {
            "min": 1000000,
            "max": 50000000
          },
          "has_website": true
        }
      }
    }
  ],
  "context": "Company Context:\n{\n  \"name\": \"Acme Automation Inc.\",\n  \"industry\": \"enterprise software\",\n  \"offering\": \"Workflow Automation Platform\",\n  \"value_proposition\": \"Reduce manual processes by 60%\",\n  \"ideal_customer\": \"Mid-sized manufacturing companies struggling with outdated processes\",\n  \"selling_points\": [\n    \"Industry-specific automation templates\",\n    \"30-day implementation guarantee\",\n    \"24/7 customer support\"\n  ]\n}",
  "supervisor": [
    {
      "agent_role": "lead_quality_analyst",
      "status": "not_initialized"
    },
    {
      "agent_role": "market_researcher",
      "status": "not_initialized"
    }
  ]
}

Response

Success Response


{
  "success": true,
  "data": {
    "command_id": "cmd_abc123def456",
    "site_id": "site_456abc",
    "status": "processing",
    "estimated_completion_time": "2024-05-02T15:30:00Z",
    "leads_requested": 25,
    "job_priority": "high",
    "process_info": {
      "stage": "initial_search",
      "progress_percentage": 5
    }
  }
}

Complete Response (via webhook or status check)


{
  "success": true,
  "data": {
    "command_id": "cmd_abc123def456",
    "site_id": "site_456abc",
    "status": "completed",
    "completion_time": "2024-05-02T14:45:22Z",
    "leads_generated": [
      {
        "id": "lead_123xyz",
        "name": "Jane Smith",
        "email": "jane.smith@example.com",
        "company": "TechCorp Manufacturing",
        "position": "CTO",
        "phone": "+1-555-123-4567",
        "website": "https://techcorp-mfg.com",
        "industry": "manufacturing",
        "company_size": "201-500",
        "location": "Chicago, IL, United States",
        "estimated_revenue": "$15M-$25M",
        "linkedin": "linkedin.com/in/janesmith",
        "match_score": 0.89,
        "match_reasons": [
          "Industry match: manufacturing",
          "Role match: CTO",
          "Company size match: 201-500 employees",
          "Interest match: automation software"
        ],
        "verified": true,
        "created_at": "2024-05-02T14:30:12Z"
      },
      // Additional leads...
    ],
    "summary": {
      "total_leads": 25,
      "average_match_score": 0.78,
      "verified_percentage": 92,
      "industries_breakdown": {
        "manufacturing": 15,
        "tech": 8,
        "saas": 2
      },
      "roles_breakdown": {
        "CTO": 10,
        "VP of Operations": 8,
        "Head of Engineering": 7
      }
    }
  }
}

Error Response


{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request parameters",
    "details": {
      "field": "leadGenData.targetAudience",
      "issue": "targetAudience object is required"
    }
  }
}

Error Codes

Code	Description
`INVALID_REQUEST`	The request parameters are invalid
`SITE_NOT_FOUND`	The specified site does not exist
`USER_NOT_FOUND`	The specified user does not exist
`QUOTA_EXCEEDED`	Your lead generation quota has been exceeded
`INSUFFICIENT_DATA`	Not enough information to generate quality leads
`SYSTEM_ERROR`	Internal system error occurred

Lead Database Structure

Field	Type	Description
`id`	uuid	Unique identifier for the lead
`site_id`	uuid	ID of the site associated with the lead
`name`	text	Full name of the lead contact
`email`	text	Email address
`phone`	text	Phone number
`company`	text	Company name
`position`	text	Job title/position
`industry`	text	Industry sector
`website`	text	Company website
`location`	text	Geographic location
`company_size`	text	Number of employees range
`revenue`	text	Estimated annual revenue
`linkedin`	text	LinkedIn profile URL
`notes`	text	Additional notes
`status`	text	Current status (e.g., “new”, “contacted”)
`score`	float	Match score (0.0-1.0)
`verified`	boolean	Whether the lead has been verified
`created_at`	timestamp	Creation date/time
`updated_at`	timestamp	Last update date/time

Status Check Endpoint

If you prefer to check the status of your lead generation command manually, you can use the status check endpoint:


GET /api/agents/sales/leadGeneration/status/:command_id

Status Response


{
  "success": true,
  "data": {
    "command_id": "cmd_abc123def456",
    "site_id": "site_456abc",
    "status": "processing",
    "progress": {
      "percentage": 65,
      "stage": "verification",
      "leads_found": 18,
      "leads_verified": 12,
      "estimated_time_remaining": "00:05:30"
    },
    "created_at": "2024-05-02T14:30:12Z",
    "updated_at": "2024-05-02T14:40:18Z"
  }
}

Lead Retrieval

Once lead generation is complete, you can retrieve the leads using the following endpoint:


GET /api/agents/sales/leadGeneration/leads/:command_id

Lead Retrieval Response


{
  "success": true,
  "data": {
    "command_id": "cmd_abc123def456",
    "leads": [
      {
        "id": "lead_123xyz",
        "name": "Jane Smith",
        "email": "jane.smith@example.com",
        "company": "TechCorp Manufacturing",
        "position": "CTO",
        "phone": "+1-555-123-4567",
        "website": "https://techcorp-mfg.com",
        "industry": "manufacturing",
        "company_size": "201-500",
        "location": "Chicago, IL, United States",
        "estimated_revenue": "$15M-$25M",
        "linkedin": "linkedin.com/in/janesmith",
        "match_score": 0.89,
        "match_reasons": [
          "Industry match: manufacturing",
          "Role match: CTO",
          "Company size match: 201-500 employees",
          "Interest match: automation software"
        ],
        "verified": true,
        "created_at": "2024-05-02T14:30:12Z"
      },
      // Additional leads...
    ],
    "pagination": {
      "total": 25,
      "page": 1,
      "per_page": 50,
      "total_pages": 1
    }
  }
}

Webhook Integration

When lead generation is complete, results can be sent to a webhook URL that you configure. This allows your systems to receive lead data as soon as it’s available.

Webhook Configuration

To configure your webhook endpoint, include the webhook parameter in your initial request:


{
  "siteId": "site_456abc",
  "leadGenData": { ... },
  "webhook": {
    "url": "https://your-domain.com/webhooks/leads",
    "secret": "your_webhook_secret",
    "metadata": {
      "campaign_id": "spring_2024",
      "source": "uncodie_api"
    }
  }
}

Parameter	Type	Required	Description
`url`	string	Yes	The URL where webhook notifications should be sent
`secret`	string	No	A secret key used to sign the webhook payload for verification
`metadata`	object	No	Additional information to include with the webhook

Webhook Request Format

When lead generation is complete, the system will make a POST request to your webhook URL with the following structure:


{
  "event": "lead_generation.completed",
  "timestamp": "2024-05-02T14:45:22Z",
  "site_id": "site_456abc",
  "command_id": "cmd_abc123def456",
  "data": {
    "status": "completed",
    "completion_time": "2024-05-02T14:45:22Z",
    "leads_count": 25,
    "summary": {
      "average_match_score": 0.78,
      "verified_percentage": 92,
      "industries_breakdown": {
        "manufacturing": 15,
        "tech": 8,
        "saas": 2
      }
    }
  },
  "metadata": {
    "campaign_id": "spring_2024",
    "source": "uncodie_api"
  },
  "signature": "sha256=..."
}

Webhook Response Expected

Your webhook endpoint should return a 2xx status code to acknowledge receipt of the webhook. If a non-2xx response is received, the system will retry delivery up to 5 times with exponential backoff.

Webhook Security

To verify that webhook requests come from our system, we include a signature in the Uncodie-Signature header. The signature is generated using HMAC with SHA-256 and your webhook secret:


// Example verification in Node.js
const crypto = require('crypto');
 
function verifyWebhookSignature(request, secret) {
  const signature = request.headers['uncodie-signature'];
  const payload = JSON.stringify(request.body);
  
  const expectedSignature = 'sha256=' + 
    crypto.createHmac('sha256', secret)
    .update(payload)
    .digest('hex');
  
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expectedSignature)
  );
}

Lead Generation Process

The lead generation process involves several steps:

Analysis: The system analyzes your target audience criteria and business information
Research: AI agents research potential leads using various data sources
Verification: Each potential lead is verified for accuracy and relevance
Scoring: Leads are scored based on how well they match your criteria
Enrichment: Lead profiles are enriched with additional data when available
Delivery: Verified leads are delivered to your account

Notes

The command executes asynchronously with results available via webhook or status check
Generated leads are automatically saved to your leads database
You can integrate the lead generation with your existing CRM systems
The system respects privacy regulations and only provides publicly available information
Lead quality is ensured through verification and scoring processes
Advanced matching algorithms ensure leads align with your ideal customer profile