Back to home

API Reference

Complete reference for all NEURON API endpoints

Base URL

https://api.neuron.ai/v1

Authentication

All API requests require an API key. Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Campaigns

POST /campaigns

Create a new campaign

GET /campaigns

List all campaigns

GET /campaigns/:id

Get campaign details

PUT /campaigns/:id

Update a campaign

Leads

POST /leads

Create and score a lead

GET /leads/:id

Get lead details and score

GET /leads/:id/intent

Get intent analysis for a lead

Analytics

GET /analytics/campaigns/:id

Get campaign performance metrics

GET /analytics/performance

Get overall performance dashboard

Error Codes

200 OK - Request successful

400 Bad Request - Invalid parameters

401 Unauthorized - Invalid API key

404 Not Found - Resource not found

429 Too Many Requests - Rate limit exceeded

500 Server Error - Internal server error

Full Documentation

For complete endpoint documentation and code examples, visit our documentation.