AI Sales Intelligence

API Documentation

Build powerful sales automation into your applications with our comprehensive API

Full Documentation

API Features

RESTful API
Simple, intuitive endpoints that follow REST conventions
Secure Authentication
API key authentication with rate limiting and usage tracking
Rich Data Access
Full access to prospects, messages, sequences, and analytics
Webhooks
Real-time notifications for events in your account
Versioned
Stable API versions with clear migration paths
SDKs Available
Official libraries for Node.js, Python, Ruby, and PHP

Quick Start

Authentication

All API requests require authentication using your API key. Include it in the Authorization header:

# Example Request
curl https://api.yourdomain.com/v1/prospects \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"

Get your API key from Settings → API Keys after creating an account.

Example: Research a Prospect
# Start research job
curl -X POST https://api.yourdomain.com/v1/research \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"linkedinUrl": "https://linkedin.com/in/john-doe",
"depth": "standard"
'}'
# Response
{
"jobId": "job_abc123",
"status": "processing",
"creditsUsed": 5
}
Webhooks

Subscribe to events in your account with webhooks. Available events:

  • •prospect.created - New prospect added
  • •research.completed - Research job finished
  • •message.sent - Message sent to prospect
  • •engagement.detected - Prospect engaged with message

Configure webhooks in Settings → Integrations → Webhooks

API Endpoints

Prospects
POST
/api/v1/prospects

Create a new prospect

GET
/api/v1/prospects

List all prospects

GET
/api/v1/prospects/:id

Get a specific prospect

PATCH
/api/v1/prospects/:id

Update a prospect

DELETE
/api/v1/prospects/:id

Delete a prospect

Research
POST
/api/v1/research

Start a research job

GET
/api/v1/research/:id

Get research job status

GET
/api/v1/research/:id/results

Get research results

Messages
POST
/api/v1/messages/generate

Generate AI message

GET
/api/v1/messages

List all messages

POST
/api/v1/messages/:id/send

Send a message

Sequences
POST
/api/v1/sequences

Create a sequence

GET
/api/v1/sequences

List all sequences

POST
/api/v1/sequences/:id/enroll

Enroll prospect in sequence

Official SDKs

Node.js / JavaScript
npm install @ai-sales/sdk
# Usage
import { AISales } from '@ai-sales/sdk'
const client = new AISales(API_KEY)
Python
pip install ai-sales-sdk
# Usage
from ai_sales import AISales
client = AISales(api_key=API_KEY)
Ruby
gem install ai_sales
# Usage
require 'ai_sales'
client = AISales::Client.new(API_KEY)
PHP
composer require ai-sales/php-sdk
// Usage
use AISales\Client;
$client = new Client($apiKey);