External API access is being rolled out in stages. Your lev8 contact will provide the API base URL and enable the entity and contact types available to your workspace.
Start with Entity Search
Send an objective toPOST /v1/entity-search. Results arrive incrementally over Server-Sent Events (SSE), so your application can process each batch before the full search finishes.
Quickstart
Make your first streaming request and handle the result.
Authentication
Create, store, and rotate an API key safely.
Entity Search
Review request fields, entity types, and response behavior.
Contact Search
Find an email address or phone number with a JSON request.
Credit balance
Check the credits currently available to your API key’s billing account.
Errors
Handle HTTP errors and failures after an SSE stream starts.
API behavior at a glance
- Authentication uses an
x-api-keyheader. API keys are separate from user sessions and internal service credentials. - Every accepted search gets a lev8 request ID. Preserve it when contacting support.
- Results stream as
entity_search_batchevents, followed byentity_search_doneand[DONE]. POST /v1/contact-searchreturns one email or phone lookup as JSON after billing settles.GET /v1/credit/balancereports the credits currently available for new requests.- Entity Search reserves credits up to the requested limit and settles against the number of unique returned entities. Contact Search reserves one lookup at the configured contact-type price.
- Idempotency prevents duplicate execution and duplicate billing; the current API does not replay a previous SSE or JSON response.