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.

Error format

The API returns errors as JSON. The format depends on the endpoint type:
{
  "error": "Rate limit exceeded. Please try again later."
}

Status codes

CodeNameWhen
200OKRequest succeeded
201CreatedResource created (monitors, lists, webhooks, API keys)
202AcceptedAsync operation queued (bulk jobs, monitor runs)
204No ContentDelete succeeded
400Bad RequestInvalid or missing request body/parameters
401UnauthorizedMissing or invalid API key
402Payment RequiredInsufficient credits for the operation
403ForbiddenPermission denied (wrong workspace role)
404Not FoundResource doesn’t exist
405Method Not AllowedWrong HTTP method
409ConflictResource already exists (duplicate)
413Payload Too LargeRequest body exceeds size limit (bulk operations)
429Too Many RequestsRate limit exceeded
500Internal Server ErrorUnexpected server failure
502Bad GatewayUpstream data provider failed
503Service UnavailableRequired service not configured

Handling errors

401 — Unauthorized

Your API key is missing, invalid, or revoked.
{"error": "unauthorized"}
Fix: Check that your Authorization: Bearer <key> header is correct and the key hasn’t been revoked.

402 — Payment Required

Your workspace has insufficient credits for the requested operation.
{"error": "Insufficient credits"}
Fix: Add credits in the dashboard billing page, or use free endpoints (validate, breaches) that don’t consume credits.

429 — Rate Limited

You’ve exceeded the request limit for this endpoint.
{"error": "Rate limit exceeded. Please try again later."}
The response includes headers to help you retry:
HeaderDescription
X-RateLimit-LimitMaximum requests allowed in the window
X-RateLimit-RemainingRequests remaining in current window
X-RateLimit-ResetUnix timestamp when the window resets
Retry-AfterSeconds until you can retry
See Rate Limits for full details.

502 — Bad Gateway

An upstream data provider (search engine, breach database, IP intelligence) failed to respond.
{"error": "upstream provider failed"}
Fix: Retry after a short delay. These are transient and typically resolve within seconds.