Introduction to Hiya APIs
This document describes the usage of Hiya REST APIs for Connect partners to integrate with the many services Hiya provides today.
If you have questions about our API, feel free to reach us at any time at api@hiya.com. If you're not fluent in English, our team speaks 20+ languages, and we likely can help in a language that works for you.
API Standards
All Hiya APIs return content in UTF-8.
Getting API Keys
Hiya will provide you with API keys to be used in testing and production environments. Determine which APIs you need to access, then take the corresponding action:
- For Connect and Audio Intelligence APIs, obtain API key(s) with self-service via the respective console.
- For Protect APIs, contact Hiya Customer Support for API key(s) to be securely delivered.
| Type | Purpose | Example |
|---|---|---|
| Production | Exclusive use in a production environment | App ID: PROD_Bt79dgG3 App Secret: 8x7AgKNmCMt90t |
| Test | For development and testing | App ID: TEST_t61lMzL3 App Secret: 9Sg33l1tR3aB78m |
The behavior of the API doesn't change based on API keys, however, Test API keys don't impact analytics, reporting, billing, and are not used by our system for data modeling and machine learning.
- Your API keys must be treated as confidential information and not be made public, stored in source control repositories, or shipped in client devices.
- Never use Test API Keys in production.
- Never use Production API Keys in development or testing.