QUICKSTART

Make your first API call.
Score a call.

Five steps. Real code in curl, Node.js, and Python. By the end you will have an API key, an authenticated request, a scored call, and a webhook arriving at your endpoint.

$20 in credits. No credit card.

01

Step 01: Get an API key

Create a free account on portal.convirza.com. The first key is generated for you. Free credits cover your first scored calls so you can run the rest of this quickstart end to end without entering a card.

Create my free API key
02

Step 02: Authenticate your first request

Pass the key in the Authorization header as a bearer token. Every request is scoped to the account that owns the key.

# 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>"
03

Step 03: Upload a recording

Send an mp3 or wav file, or a URL to one. The endpoint returns a call ID immediately, and processing runs asynchronously after the response comes back.

curl https://platform-api.convirza.com/v3/conversations/calls \
  -H "Authorization: Bearer <access_token>"

# Full reference: docs.convirza.com
04

Step 04: Pull the results

Call Get Call By ID with include=transcription,summary,scorecard. The scorecard status field shows when scoring is done. For live tracking-number calls, add a post-call webhook instead of polling.

# The webhook gives you a call ID. One request returns the rest.
curl "https://platform-api.convirza.com/v3/conversations/calls/{id}?include=transcription,summary,scorecard,dni_data" \
  -H "Authorization: Bearer $CONVIRZA_TOKEN"
05

Step 05: Move to production

Add billing when you need credits beyond your free $20. If you operate at the scale of a vertical SaaS or agency network, talk to a solutions engineer about volume pricing and a dedicated onboarding plan.

Talk to a solutions engineer
READY TO SCORE YOUR FIRST CALL?

Get your API key. One click away.

Create the key. Run the curl. Catch the webhook. The rest is your product.

Ready to build on Convirza?
Start freeGet a demo