Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.viddyscribe.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Quick Setup

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

Get Your API Key

Reach out to hello@viddyscribe.com to obtain a plan and your API key.
X-API-Key: vsk_your_api_key_here
2

Generate Audio Descriptions (Text Only)

Upload your video and generate descriptions in one step:
curl -X POST https://api.viddyscribe.com/enterprise/api/generate_ad_text \
  -H "X-API-Key: vsk_your_api_key_here" \
  -F 'input={"type": "file"}' \
  -F "file=@video.mp4" \
  -F 'generation_config={"language": "en-US", "ad_type": "extended_ad", "format": "vtt"}'
You can also pass input.type: "url" or input.type: "media_id" instead of uploading a file directly — see the generate AD text reference for the JSON variants.
Response:
{
  "job_id": "task_abc123xyz",
  "status": "queued",
  "media_id": "550e8400-e29b-41d4-a716-446655440000"
}
3

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",
  "media_id": "550e8400-e29b-41d4-a716-446655440000",
  "output": {
    "format": "vtt",
    "content": "WEBVTT\n\n1\n00:00:00.500 --> 00:00:03.100\nA woman in a yellow top sits at a desk with a laptop.\n\n2\n00:00:03.200 --> 00:00:05.900\nShe looks at the camera and smiles."
  }
}

​
That’s it!

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

​
What’s Next?

API Reference

Explore all available endpoints

Authentication

Learn about API authentication

Looking to generate AD audio?

Generate a standalone audio track with descriptions

Looking to generate video with baked in AD?

Generate an MP4 with descriptions mixed in