Skip to content

Basics

API reference

Post leads, then read back what the AI voice agent did with them. Each page below is generated from the spec the API publishes, so it matches what the API accepts and returns.

Base URL https://api.entrovox.com/v1

On this page

Authentication

Send your key in the Authorization header, with the scheme ApiKey. Keep it in an environment variable such as ENTROVOX_KEY, never in client-side code.

A key can call only the endpoints in this reference. Any other endpoint returns API_KEY_ENDPOINT_NOT_ALLOWED, and an expired key returns API_KEY_EXPIRED.

Idempotency

Send an Idempotency-Key header with a UUID you generate for each new request. Resending the same key and body returns the original response, so a network retry never creates a second record. These endpoints take it:

For leads, external_id is the durable identity; the header covers retries of the same request.

Pagination

Lists of leads and calls take limit and a cursor. Pass meta.next_cursor from one page as the next request's cursor, and stop when meta.has_more is false. Lists of phone numbers and AI voice agents take page and a page size instead.

Errors

A failed request returns an error object. Branch on code, not on the message. param names the field that failed when there is one, and request_id is what to quote when you contact us. Each endpoint page lists the codes it can return, with what to do next:

  • Retrying will fail the same way. Fix the request, or contact us.
  • The lead or request already exists. Fetch it instead of sending it again.
  • Retry after the time in details.next_attempt_local when present. Otherwise retry when the blocking condition ends, as the meaning says.
  • Safe to retry after Retry-After when present, otherwise back off. On a POST, resend the same Idempotency-Key and body.

Resources