1. Get started
  • HMS Sovereign API
  • Get started
    • Authentication
    • Introduction
    • Quickstart
  • Core concepts
    • Assistants
    • Calls
    • Phone Numbers
    • Webhooks
  • Platform
    • Billing & Credits
    • EU Data Sovereignty
    • Voice Selection
    • Whitelabel Portal
  • Webhooks
    • Assistant Request
    • End of Call Report
    • Webhooks Overview
    • Webhook Security
    • Status Update
    • Tool Calls
  • Configuration
    • Analysis Templates
    • Custom Tools
    • SIP Trunks
    • Tool Templates
  • Features
    • AI Generation
    • Autonomous Silence Handling
    • Call Analysis
    • Call Transfers
    • Campaigns Setup
    • Outbound Campaigns
    • Voicemail Detection
    • Web Calls
  • Integrations
    • BYOK Setup
    • Provider Pricing
    • xAI Grok Integration
  • Reference
    • Error Codes
    • Rate Limits
    • Troubleshooting
Documentation
API Reference
Documentation
API Reference
Book a meeting
Linkedin
Github
  1. Get started

Authentication

All API requests require authentication using a Bearer token in the Authorization header.

Getting Your API Key#

1.
Log in to the HMS Sovereign dashboard
2.
Navigate to Settings > API Keys
3.
Copy your API key

Making Authenticated Requests#

Include your API key in the Authorization header with every request:

Request Headers#

HeaderValueRequired
AuthorizationBearer YOUR_API_KEYYes
Content-Typeapplication/jsonFor POST/PATCH requests

Example: Get Account Information#

Response:
{
  "id": "user-uuid-here",
  "email": "you@example.com",
  "company_name": "Your Company",
  "minutes_balance": 500,
  "monthly_usage_minutes": 120,
  "active_numbers": 3,
  "active_agents": 2,
  "active_calls": 0
}
See Get Account Information for full details.

Rate Limits#

The API enforces the following rate limits:
Limit TypeRate
General API requests100 requests per minute per API key
Call control commands10 commands per minute per active call
When you exceed a rate limit, the API returns a 429 Too Many Requests response.

Error Responses#

401 Unauthorized#

Returned when the API key is missing, invalid, or expired.
{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

403 Forbidden#

Returned when your API key doesn't have permission for the requested resource.
{
  "error": "Forbidden",
  "message": "You don't have access to this resource"
}

Security Best Practices#

1.
Never expose your API key in client-side code - Always make API calls from your server
2.
Rotate keys periodically - Generate new keys and revoke old ones regularly
3.
Use environment variables - Store keys in environment variables, not in code
4.
Monitor usage - Check your account dashboard for unexpected API activity
Modified at 2026-03-17 10:59:50
Previous
HMS Sovereign API
Next
Introduction
Built with