Authentication

All VoxParse API requests (except /health) require authentication via an API key. You can generate keys from the Dashboard.

Authentication Methods

Pass your API key using either method:

Method	Header	Example
Custom Header	`X-API-Key`	`X-API-Key: vxp_live_abc123...`
Bearer Token	`Authorization`	`Authorization: Bearer vxp_live_abc123...`

Code Examples

curl

curl https://api.voxparse.com/v1/balance \
  -H "X-API-Key: YOUR_API_KEY"

Python

import requests

headers = {"X-API-Key": "YOUR_API_KEY"}
r = requests.get("https://api.voxparse.com/v1/balance", headers=headers)
print(r.json())

Node.js

const res = await fetch("https://api.voxparse.com/v1/balance", {
  headers: { "X-API-Key": "YOUR_API_KEY" }
});
const data = await res.json();
console.log(data);

API Key Security

Important: Never expose your API key in client-side code. Store it in environment variables and make API calls from your server.

Keys are prefixed with vxp_live_ for production or vxp_test_ for sandbox
You can create multiple keys per project in the Dashboard
Revoke compromised keys instantly from the Dashboard
Each key tracks usage independently for audit purposes

Error Responses

If authentication fails, you will receive a 401 Unauthorized response:

401 Response

{
  "error": {
    "message": "Invalid API key.",
    "code": 401
  }
}