API Reference
Hail exposes a REST API at https://api.hail.so. Every endpoint below is generated from openapi/openapi.yaml, the canonical contract that CI verifies against the live service, so this reference never drifts from the code.
Machine-readable spec: openapi.yaml · openapi.json
Try every endpoint in Postman. Fork the public collection, paste your key into api_key, then open Start here.
Every page below (and every guide) is also available as plain markdown — append .md to its URL, or fetch llms.txt (index) or llms-full.txt (everything, concatenated).
- Acquire Number
- Activate Provider
- Cancel Verification
- Check Domain
- Confirm Verification
- Create Agent
- Create Call
- Create Contact
- Create Email
- Create Email Attachment
- Create Email Domain
- Create Sms
- Create Subscription
- Create Verification
- Delete Agent
- Delete Contact
- Delete Email Domain
- Delete Email Suppression
- Delete Member Phone
- Delete Provider
- Delete Sms Suppression
- Delete Subscription
- Dns Check Email Domain
- Enable Sms
- Get Agent
- Get Call
- Get Email
- Get Email Attachment
- Get Email Domain
- Get Email Raw
- Get Email Stats
- Get Number
- Get Prompt Templates
- Get Recording
- Get Requirements
- Get Sender Id
- Get Sms
- Get Subscription
- Get Verification
- Get Whoami
- Healthz
- List Agents
- List Calls
- List Contacts
- List Deliveries
- List Email Domains
- List Email Events
- List Email Suppressions
- List Emails
- List Event Types
- List Events
- List Forward Targets
- List Number Regions
- List Numbers
- List Providers
- List Sms
- List Sms Suppressions
- List Subscriptions
- List Verifications
- Patch Contact
- Patch Email Domain
- Patch Sender Id
- Patch Subscription
- Put Member Phone
- Quote Numbers
- Redeliver
- Release Number
- Resend Forward Confirm
- Rotate Secret
- Route Number
- Unsubscribe
- Unsubscribe
- Update Agent
- Upsert Provider
- Validate Provider
- Verify Email Domain