Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encrata.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Encrata supports two bulk operation modes:
  1. Inline bulk — Send an array of queries in a single POST request (up to 100 items)
  2. Async bulk jobs — Upload a CSV file for background processing (up to 10,000 rows)

​
Inline Bulk Endpoints

These endpoints accept an array of queries and return results synchronously. Best for smaller batches (≤100 items).

​
Bulk Email Lookup

POST /api/bulk-lookup
​
emails
string[]
required
Array of email addresses to enrich (max 1,000).
Example: 
curl -X POST "https://encrata.com/api/bulk-lookup" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "emails": ["alice@company.com", "bob@startup.io"] }'
Results are streamed via Server-Sent Events (SSE) for real-time progress. 
POST /api/bulk-google-search
​
queries
string[]
required
Array of search queries (max 100).
POST /api/bulk-company-search
​
queries
string[]
required
Array of company names or domains (max 100).
POST /api/bulk-domain-search
​
queries
string[]
required
Array of domain names (max 100).
POST /api/bulk-ip-search
​
queries
string[]
required
Array of IP addresses (max 100).

​
Async Bulk Jobs

For large-scale operations (100–10,000 records), use async bulk jobs. Upload a CSV, and results are processed in the background.

​
Create Bulk Job

POST /api/bulk-jobs
Upload a CSV file with a column of queries. The job processes in the background and notifies you when complete. Form fields:
FieldTypeRequiredDescription
filefileYesCSV file with queries
typestringYesLookup type: email, phone, company, domain, ip, darkweb
columnstringNoColumn name containing the queries (auto-detected if omitted)
Example: 
curl -X POST "https://encrata.com/api/bulk-jobs" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "file=@leads.csv" \
  -F "type=email"
Response: 
{
  "id": "job_abc123",
  "status": "processing",
  "total_rows": 5000,
  "processed": 0,
  "created_at": "2026-06-01T10:00:00Z"
}

​
Get Bulk Job Status

GET /api/bulk-jobs?id={job_id}
Returns current progress and status. Response: 
{
  "id": "job_abc123",
  "status": "completed",
  "total_rows": 5000,
  "processed": 5000,
  "credits_used": 5000,
  "created_at": "2026-06-01T10:00:00Z",
  "completed_at": "2026-06-01T10:05:30Z"
}
Statuses: queued, processing, completed, failed, cancelled

​
Download Results

GET /api/bulk-jobs/download?id={job_id}
Downloads the enriched results as a CSV file once the job is complete.

​
Cancel Bulk Job

DELETE /api/bulk-jobs?id={job_id}
Cancels a running bulk job. Already-processed rows are kept.

​
Credits

Each row in a bulk operation consumes credits at the standard rate for that lookup type. Failed lookups (invalid input) do not consume credits.
Lookup TypeCredits per Row
Email1
Phone1
Company1
Domain1
IP1
Dark Web1
Google Search1

​
Webhooks

When a bulk job completes, the bulk_job.completed webhook event is fired if you have webhooks configured.