API Documentation
Complete reference for the Neon Intelligence API. Integrate web extraction, AI-powered company dossiers, lead prospecting, and email verification into your own applications.
Authentication & Limits
Authenticate your API requests by including your API key in the headers or the request body.
Header: x-api-key: neon_sk_...
Body: { "apiKey": "neon_sk_..." }
Body: { "apiKey": "neon_sk_..." }
Free Tier
- • 50 API calls / day
- • Masked emails in prospect
- • Locked pitch angles
- • Standard rate limits
Pro Tier
- • 5,000 API calls / day
- • Full lead data
- • AI pitch generation
- • Higher rate limits
Business Tier
- • 25,000 API calls / day
- • Priority processing
- • Dedicated support
- • Custom rate limits
POST
/api/v1/extract
Extract clean text or markdown from any web page. Ideal for feeding context into LLMs.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| url | string | Yes | The URL to extract content from. |
| format | 'markdown' | 'text' | No | Output format. Defaults to 'text'. |
| onlyMainContent | boolean | No | If true, strips navbars and footers. |
| stealth | boolean | No | Bypass simple bot protections. |
Response Example
{
"success": true,
"data": {
"url": "https://example.com",
"title": "Example Domain",
"content": "This domain is established to be used for illustrative examples...",
"wordCount": 42,
"tokenEstimate": 55
},
"meta": {
"method": "fast",
"timingMs": 420,
"tier": "pro"
}
}POST
/api/v1/dossier
Generate a comprehensive AI dossier on a company including tech stack, vulnerabilities, and personalized pitch angles.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| domain | string | Yes | The company website domain (e.g., 'stripe.com'). |
| pitchContext | string | No | What you are selling, to guide the generated pitch angles. |
Response Example
{
"success": true,
"dossier": {
"domain": "stripe.com",
"company_name": "Stripe",
"executive_summary": "Financial infrastructure platform for the internet.",
"business_model": "B2B SaaS / Fintech",
"detected_technologies": ["React", "Node.js", "AWS", "Datadog"],
"tech_vulnerabilities": ["High latency in regional routing observed"],
"lead_score": 94,
"pitch_angles": [
"Highlight our latency optimization given their regional routing issues."
]
}
}POST
/api/v1/prospect
Search our B2B database for verified leads matching your criteria.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | No | Free text search over company names and descriptions. |
| industry | string | No | Filter by industry (e.g., 'Software'). |
| country | string | No | ISO country code (e.g., 'US'). |
| limit | number | No | Max results (default 10, max 100). |
Response Example
{
"success": true,
"total_matched": 12450,
"returned_count": 2,
"leads": [
{
"company_name": "TechFlow Innovations",
"website": "techflow.io",
"contact_email": "hello@techflow.io",
"category": "Software",
"country": "US"
},
{
"company_name": "DataSync Corp",
"website": "datasync.co",
"contact_email": "partners@datasync.co",
"category": "Software",
"country": "CA"
}
]
}POST
/api/v1/verify
Verify B2B email addresses in real-time, checking MX records and provider configurations.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | The email address to verify. |
Response Example
{
"success": true,
"email": "contact@example.com",
"domain": "example.com",
"deliverable": true,
"provider": "Google Workspace",
"primaryMx": "aspmx.l.google.com",
"score": 0.98
}