Documentation

Making Your First Request

This guide walks you through making your first API call to transcribe a media file.

Prerequisites

  • Active API key
  • Media file URL (publicly accessible)
  • Sufficient account balance

Step-by-Step Guide

1. Prepare Your Media File

Ensure your media file is:

  • Publicly accessible via HTTPS
  • In a supported format (MP4, MP3, WAV, MOV, AVI, etc.)
  • Under 3500 MB in size

2. Make the API Call

bash
curl -X POST https://api.rednerapp.com/v1/transcribe \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mediaUrl": "https://example.com/video.mp4",
    "sourceLanguage": "en-US"    
  }'

3. Handle the Response

Success response:

json
{
  "jobId": "abc123-def456-ghi789",
  "status": "pending",
  "message": "Transcription job started successfully"
}

4. Monitor Job Status

Set up a webhook URL in your Settings to receive real-time notifications when your job completes. This is the recommended approach for production applications.

Alternatively, you can view job status in the Jobs page of the Developer Portal.

5. Retrieve Results

Once the job is complete, the webhook notification will include the output URL. You can download the result file directly from the provided S3 URL.

Code Examples

Python

python
import requests

url = "https://api.rednerapp.com/v1/transcribe"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "mediaUrl": "https://example.com/video.mp4",
    "sourceLanguage": "en-US"
}

response = requests.post(url, json=data, headers=headers)
job = response.json()
print(f"Job ID: {job['jobId']}")

JavaScript

javascript
const response = await fetch('https://api.rednerapp.com/v1/transcribe', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    mediaUrl: 'https://example.com/video.mp4',
    sourceLanguage: 'en'
  })
});

const job = await response.json();
console.log('Job ID:', job.jobId);

Java

java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.rednerapp.com/v1/transcribe"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(
        "{\"mediaUrl\":\"https://example.com/video.mp4\"," +
        "\"sourceLanguage\":\"en\"}"
    ))
    .build();

HttpResponse<String> response = client.send(
    request, 
    HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());