API Reference

Paradigm API Documentation

Programmatic access to lead enrichment, email personalization, blueprint management, and auto responder configuration.

Base URL:https://paradigm-api-a9111b9383f1.herokuapp.com/v1

Getting Started

The Paradigm API provides programmatic access to core platform features. Use it to automate lead enrichment, generate personalized emails, manage blueprints, and configure auto responders.

01
Get your API key
Go to Settings > API Keys in your dashboard
02
Purchase credits
API calls consume credits. Buy them in your dashboard.
03
Make your first call
Send a request with your X-API-Key header.
bash
curl -X GET "https://paradigm-api-a9111b9383f1.herokuapp.com/v1/jobs" \
  -H "X-API-Key: pk_live_your_api_key_here"

Authentication

All API endpoints require authentication using an API key. Include your key in the X-API-Key header with every request.

API keys can be created and managed in your Paradigm dashboard under Settings > API Keys. Keys use the format pk_live_....

Keep your API keys secure

Never expose API keys in client-side code, public repositories, or share them publicly. If a key is compromised, regenerate it immediately from your dashboard.

Rate Limiting

The API is rate limited to 100 requests per minute per API key.

Credits & Pricing

Write operations that trigger AI research or email personalization consume credits. Read operations, template management, and auto responder configuration are free.

OperationResearch ModeCredits
Create Jobstandard1
Create Jobpremium2
Create Enrichmentstandard1
Create Enrichmentpremium2
All read / list / delete ops—Free
Blueprint management—Free
Auto responder config—Free

Premium research mode uses deeper AI analysis for higher quality results. Credits are deducted at the time of request and automatically refunded if the operation fails.

Error Handling

All errors return a consistent JSON structure:

json
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}
StatusCodeDescription
400VALIDATION_ERRORInvalid request parameters
401MISSING_API_KEYNo API key provided
401INVALID_API_KEYAPI key is invalid or inactive
402INSUFFICIENT_CREDITSNot enough credits for this operation
404NOT_FOUNDResource not found
429RATE_LIMITEDToo many requests
500INTERNAL_ERRORServer error

Jobs

Create and manage enrichment and personalization jobs. Jobs process leads through AI research and email customization pipelines.

Enrichments

Access and create enrichment data for leads. Enrichments contain AI-researched company and person intelligence used for personalization.

Blueprints

Manage enrichment templates (research blueprints) and customization templates (email personalization blueprints). All blueprint operations are free.

Enrichment Templates

Customization Templates

Auto Responders

Configure and manage AI-powered email and LinkedIn auto responders. All auto responder management operations are free.

Email Auto Responders

LinkedIn Auto Responders

API Sandbox

Try out the API interactively. Select an endpoint below to see the full request and response cycle. These are simulated responses showing exactly what you'd receive from the live API.

Request

bash
curl -X GET "https://paradigm-api-a9111b9383f1.herokuapp.com/v1/jobs?status=completed&limit=5" \
  -H "X-API-Key: pk_live_your_api_key_here"