Skip to main content

​
Authentication

All requests to the Heify API must be authenticated using an API Key. This key identifies your account and ensures secure access to your transcription resources.

​
Obtaining Your API Key

You can generate and manage your API Keys from the Sandbox or your Heify Dashboard.
1

Access the Sandbox

Navigate to the Sandbox and authenticate with your credentials
2

Go to API Keys section

Access the API Keys & Sandbox page
3

Generate a new key

Click “Create New API Key” and give it a descriptive name
4

Save your key securely

Copy the key immediately - it will only be shown once
Keep your API key secure! Never share it publicly or commit it to version control. Treat it like a password.

​
Using Your API Key

Include your API key in the x-api-key header with every API request:

​
Header Format

HeaderValue
x-api-keyYOUR_API_KEY
Content-Typeapplication/json

​
Example Requests

curl -X POST https://api.heify.com/get-configurations \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{}'

​
Best Practices

Store your API key in environment variables, not in your source code.
export HEIFY_API_KEY="your_actual_key_here"
Then reference it in your code:
import os
api_key = os.environ.get('HEIFY_API_KEY')
Use different API keys for development, staging, and production environments. This allows you to rotate keys without affecting all environments.
For enhanced security, periodically generate new API keys and deactivate old ones from your dashboard.

​
Authentication Errors

If authentication fails, you’ll receive a 403 Forbidden response. Common causes of authentication errors:
  • Missing header: The x-api-key header was not included in the request
  • Invalid key: The API key is incorrect or has been deactivated
  • Expired key: The API key has been deleted from your account
If you receive authentication errors, verify that:
  1. The API key is correct and active in your dashboard
  2. The x-api-key header is properly formatted
  3. There are no extra spaces or special characters in the key

​
Next Steps

Quickstart Guide

Make your first API call

API Reference

Explore available endpoints