Skip to main content

​
Quick Setup

Get your first audio description video in 3 simple steps.
1

Get Your API Key

Reach out to [email protected] to obtain your API key.
X-API-Key: vsk_your_api_key_here
2

Upload Your Video

Upload a video file or provide a URL:
curl -X POST https://api.viddyscribe.com/enterprise/api/upload_media \
  -H "X-API-Key: vsk_your_api_key_here" \
  -F "[email protected]"
Response:
{
  "media_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "created",
  "duration_seconds": 45.5,
  "frame_rate": 30.0
}
3

Generate Audio Descriptions

Start generating descriptions:
curl -X POST https://api.viddyscribe.com/enterprise/api/generate_ad_text \
  -H "X-API-Key: vsk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "media_id": "550e8400-e29b-41d4-a716-446655440000",
    "language": "en-US",
    "ad_type": "extended_ad"
  }'
Response:
{
  "job_id": "task_abc123xyz",
  "status": "queued",
  "media_id": "550e8400-e29b-41d4-a716-446655440000"
}
4

Get Your Results

Poll for completion and download:
curl -X GET "https://api.viddyscribe.com/enterprise/api/get_results?job_id=task_abc123xyz" \
  -H "X-API-Key: vsk_your_api_key_here"
When done:
{
  "job_id": "task_abc123xyz",
  "status": "done",
  "result_url": "https://storage.googleapis.com/.../result.mp4?X-Goog-Signature=..."
}

​
That’s it!

A 10 minute video usually takes about 5 minutes for descriptions to be generated.

​
What’s Next?

API Reference

Explore all available endpoints

Authentication

Learn about API authentication

Supported Languages

39 languages supported

Video Categories

Optimize for different content types