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.

How credits work

Every Encrata workspace has a credit balance. Most enrichment endpoints consume 1 credit per request. Some endpoints are completely free. Credits are deducted after a successful response — if a lookup fails (502, 503), you’re not charged.

Credit costs

EndpointDescription
/api/agent/lookupFull email enrichment
/api/agent/googleGoogle search
/api/agent/companyCompany intelligence
/api/agent/domainDomain WHOIS + knowledge graph
/api/agent/ipIP geolocation + threat data
/api/agent/darkwebDark web search (1 credit per 100 results)

Free endpoints (0 credits)

EndpointDescription
/api/agent/validateEmail deliverability check
/api/agent/breachesBreach history lookup
GET /api/agent/monitorsList/get monitors
POST /api/agent/monitorsCreate monitor
GET /api/agent/monitoring/runsList runs
GET /api/agent/monitoring/resultsList results
GET /api/agent/listsList contact lists
GET/POST /api/webhooksWebhook management
GET /api/healthHealth check

Bulk & monitor runs

OperationCost
Bulk lookup (up to 1000 emails)1 credit per successful enrichment
Monitor run trigger1 credit per target in the monitor
Dark web search charges 1 credit per 100-result page. A search returning 250 results costs 3 credits (pages 0–99, 100–199, 200–249).

Checking your balance

Your current credit balance is visible in the dashboard.

Insufficient credits

When you don’t have enough credits, the API returns:
{
  "error": "Insufficient credits"
}
With HTTP status 402 Payment Required.

Webhook alerts

Set up webhooks to get notified about credit usage:
EventTrigger
credits.lowCredits drop below your configured threshold
credits.exhaustedCredits reach zero
See Webhooks to configure these alerts.

Tips

Use free endpoints first

Validate emails before enriching — skip invalid addresses to save credits.

Select fields

Use the fields parameter to request only what you need. Reduces response size (same credit cost, but faster).

Use monitors for recurring

Instead of manual re-lookups, set up monitors — they only charge for actual enrichment runs.

Bulk for volume

Bulk endpoints have the same per-item cost but lower rate limits, making high-volume work easier.