ClarityCall
Log In Get Started

Getting Started

This guide will help you make your first API call to ClarityCall in just a few steps.

Prerequisites

Step 1: Get Your API Key

Navigate to your API Keys settings page and create a new API key. Copy the key - you'll need it for authentication.

Important: Store your API key securely. It provides full access to your account and should never be exposed in client-side code or public repositories.

Step 2: Make Your First Request

Let's fetch your recordings to verify your API key works:

bash
curl -X GET "https://api.claritycall.app/api/v2/recordings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

You should receive a JSON response with your recordings:

json
{
  "recordings": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "filename": "team-standup-2024-01-15.mp3",
      "title": "Team Standup",
      "meeting_date": "2024-01-15T10:00:00Z",
      "status": "completed",
      "progress": 100
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

Step 3: Upload a Recording

To upload a new recording, first request a presigned URL:

bash
curl -X POST "https://api.claritycall.app/api/v2/recordings/presigned-url" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "meeting.mp3",
    "content_type": "audio/mpeg",
    "file_size": 1048576,
    "speakers_expected": 2
  }'

Then upload your file to the presigned URL and complete the upload:

bash
# Upload file to presigned URL
curl -X PUT "PRESIGNED_UPLOAD_URL" \
  -H "Content-Type: audio/mpeg" \
  --data-binary @meeting.mp3

# Mark upload as complete to start processing
curl -X POST "https://api.claritycall.app/api/v2/recordings/complete-upload" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recording_id": "RECORDING_ID"}'

Next Steps