​

API Authentication

Authorization: Bearer sayvy_sk_live_your_secret_key

​

Generating an API Key

1. Navigate to Developers > API Keys in the sidebar.
2. Click Create New API Key.

3. Provide a descriptive key name (e.g. Production Call Worker), set permissions/scopes, and select an optional expiration date.

4. Copy your secret key immediately. For security, Sayvy AI never reveals the full secret key again.

​

Key Types & Environments

​

Granular Scopes

• full_access: Unrestricted access across all workspace resources.
• agents:read: List and fetch voice agent configurations.
• agents:write: Create, update, or delete voice agents.
• calls:dispatch: Trigger outbound phone calls and WebRTC sessions.
• calls:read: View call logs, metrics, recordings, and transcripts.
• campaigns:manage: Create and schedule outbound batch campaigns.
• webhooks:admin: Manage webhook endpoints and signing secrets.

​

Making Authenticated Requests

​

cURL Example

curl -X GET https://api.sayvy.ai/api/v1/agents \
  -H "Authorization: Bearer sayvy_sk_live_bb034ea7fbe133e088954dca4025be408cb1edd5" \
  -H "Content-Type: application/json"

​

Node.js / TypeScript Example

const response = await fetch('https://api.sayvy.ai/api/v1/agents', {
  headers: {
    'Authorization': `Bearer ${process.env.SAYVY_API_KEY}`,
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

​

Python Example

import os
import requests

api_key = os.environ.get("SAYVY_API_KEY")

headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json",
}

response = requests.get("https://api.sayvy.ai/api/v1/agents", headers=headers)
print(response.json())

​

Failed Authentication

{
  "error": {
    "code": "invalid_api_key",
    "message": "The provided API key is expired, revoked, or formatted incorrectly.",
    "type": "authentication_error"
  }
}