Quickstart Guide

Let's analyze your first audio file in a few steps. By the end, you'll have submitted a job and received a complete analysis.

Step 1: Get Your API Key

First, you'll need an API key. You can get one for free from your ConvoTune Dashboard after signing in.

Step 2: Prepare Your Audio File

Grab any audio file (.mp3, .wav, .m4a) you have on hand. No audio file? Download our sample to get started:

Step 3: Submit the Analysis Job

Now, let's send the file to our API using cURL. This call will immediately return a job_id. For the webhook_url, we recommend a free service like webhook.site for testing.

                
curl -X POST "https://api.convotune.com/api/v1/jobs/" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "file=@/path/to/your/test-call.mp3" \
-F "webhook_url=https://webhook.site/your-unique-url"
                
            

You will receive an immediate response like this:

                
{
    "job_id": "687370cfb0e401e92a4336ed",
    "status": "queued",
    "message": "Job accepted for analysis..."
}
                
            

Step 4: Receive the Result

After a few moments, our system will send a POST request to your webhook_url with the full JSON payload. Here’s an example of what you’ll receive:

                
{
    "job_id": "687370cfb0e401e92a4336ed",
    "status": "completed",
    "data": {
        "call_summary": {
            "title": "Promotional Call Highlighting Deposit Bonus",
            "key_topics": ["Deposit bonus", "Winning opportunities"],
            "next_steps": ["Customer to consider the deposit bonus."]
        },
    // ... and so on
    }
}
                
            

Congratulations! You've successfully analyzed your first conversation. Now check out the full API Reference to learn more.