Getting Started

1. Create an Account

If you haven't already, create an account. You'll need to verify your email address before you can use the API.

2. Add Credit

Navigate to Billing → Top Up and add credit to your account. Pricing is pay-as-you-go at $0.016 AUD per minute of audio.

3. Generate an API Key

Go to Settings → API Keys and create a new API key. Important: Copy your API key immediately - it will only be shown once.

4. Make Your First Request

Use your API key to submit an audio file for transcription:

curl -X POST https://api.icana.ai/api/v1/transcribe \
  -H "X-API-Key: sk_test_your_api_key_here" \
  -F "file=@your-audio.mp3" \
  -F "language=en"

The response will include a job_id:

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing",
  "message": "Job submitted successfully. Poll the status endpoint to check progress."
}

5. Poll for Results

Use the job ID to check the status and retrieve results. We recommend polling every 5-10 seconds. If you receive a 429 response, wait for the number of seconds specified in the Retry-After header before retrying.

curl https://api.icana.ai/api/v1/jobs/550e8400-e29b-41d4-a716-446655440000 \
  -H "X-API-Key: sk_test_your_api_key_here"

When the job is complete, the response includes the transcription and diarization:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "audio_duration_seconds": 180,
  "audio_duration_minutes": 3.0,
  "transcription": "Hello, this is the transcribed text...",
  "diarization": "[Speaker 1]: Hello...\n[Speaker 2]: Hi there...",
  "created_at": "2025-02-03T10:30:00Z",
  "completed_at": "2025-02-03T10:32:00Z"
}

Supported Audio Formats

• MP3 (.mp3)
• WAV (.wav)
• OGG (.ogg)
• FLAC (.flac)
• M4A (.m4a)
• MP4 (.mp4) - audio only

Maximum file size: 500 MB

Supported Languages

We support all languages supported by OpenAI Whisper. The most common include:

• en - English
• es - Spanish
• fr - French
• de - German
• ja - Japanese
• zh - Chinese