Skip to main content
The full OptimalDial API is described in a single OpenAPI 3.1 document, served live from the API itself. It covers all 8 paths and 12 schemas in the public surface, including security schemes, examples, error envelopes, and rate-limit response shapes. For interactive endpoint pages with a “Try it” playground, see the API Reference section in the sidebar.

​
Download

Fetch the spec from the API itself — the same host you call for everything else:
It’s served as application/yaml with a 5-minute cache. No authentication is required; the endpoint is public by design.

​
Import into your tool of choice

  1. Open Postman → Import → File → select openapi.yaml.
  2. Choose Generate collection from imported APIs when prompted.
  3. Add an environment variable api_key with your od_live_… value, and reference it in the collection’s authorization tab.

​
What’s covered

Schemas: Upload, UploadCreateJson, DownloadUrl, Contact, ContactCreate, WebhookEndpoint, WebhookEndpointCreate, WebhookEndpointUpdate, WebhookEndpointCreateResponse, WebhookDelivery, CreditBalance, plus error envelopes (ErrorEnvelope, MinContactsError, RateLimitError, PingFailedError). The spec’s info.version matches the webhook payload api_version field (2026-04-23) and is bumped only when the wire format changes — consult the Changelog for what each version included.