API KEYS
Exchange your key for a token.
Get your API key and secret from the portal's API Access page. Exchange them for a Bearer token, valid for 7 days, and pass it in the Authorization header. Refresh tokens last 6 months, and revocation from the portal is immediate.
# Step 1: exchange your API key and secret for a token (valid 7 days)
curl -X POST https://platform-oauth.convirza.com/oauth/token/client-credentials \
-H "Content-Type: application/json" \
-d '{"api_key": "your-api-key", "api_secret": "your-api-secret"}'
# Step 2: use the token
curl https://platform-api.convirza.com/v3/conversations/calls \
-H "Authorization: Bearer <access_token>"// Node.js 18+ has fetch built in.
// Step 1: exchange your API key and secret for a token (valid 7 days)
const authRes = await fetch('https://platform-oauth.convirza.com/oauth/token/client-credentials', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
api_key: process.env.CONVIRZA_API_KEY,
api_secret: process.env.CONVIRZA_API_SECRET,
}),
});
const { access_token } = await authRes.json();
// Step 2: call the API with the token
const res = await fetch('https://platform-api.convirza.com/v3/conversations/calls', {
headers: { Authorization: `Bearer ${access_token}` },
});
const data = await res.json();
console.log(data);import os
import requests
# Step 1: exchange your API key and secret for a token (valid 7 days)
auth = requests.post(
'https://platform-oauth.convirza.com/oauth/token/client-credentials',
json={
'api_key': os.environ['CONVIRZA_API_KEY'],
'api_secret': os.environ['CONVIRZA_API_SECRET'],
},
)
access_token = auth.json()['access_token']
# Step 2: call the API with the token
response = requests.get(
'https://platform-api.convirza.com/v3/conversations/calls',
headers={'Authorization': f'Bearer {access_token}'},
)
print(response.json())OAUTH 2.0
For the hosted MCP server.
Connect Claude, ChatGPT, Cursor, VS Code or Codex to the hosted Convirza MCP server at connect.convirza.com/mcp using OAuth 2.0 with PKCE, included at no extra charge. Webhooks and subscriptions created through MCP still require the Admin role.
Read the MCP auth flowOPERATIONS
Rotate without downtime.
- Issue a new key from the dev portal. Old key keeps working.
- Deploy the new key to your application secrets.
- Confirm the new key is in use by checking the per-key request logs in the portal.
- Revoke the old key. Effective immediately.
- Set a calendar reminder. We recommend rotating every 90 days.