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.

ViddyScribe supports two audio description types, each with different output formats:
AD TypeOutputs
Standard AD (no pauses) descriptions placed in dialogue gapsText, Audio, Video
Extended AD (with pauses) descriptions added with pausesText, Video
For a deeper breakdown of when to choose each mode, see Standard AD vs Extended AD.

Input Video

Output AD Video

Output AD Audio

Output AD Text (VTT)

WEBVTT

1
00:00:00.000 --> 00:00:02.000
A woman with long dark hair, wearing a pink cardigan, sits on a sofa and speaks to the camera.

2
00:00:02.570 --> 00:00:04.570
A mechanic in blue gloves measures a car's brake disc.

3
00:00:05.370 --> 00:00:07.370
The mechanic removes a wheel from a silver car, which is propped up on a jack; a blue RepairSmith van is parked in front of a house, next to the car.

4
00:00:09.290 --> 00:00:11.290
The woman looks at a laptop displaying the RepairSmith website.

5
00:00:16.000 --> 00:00:18.000
The laptop screen shows a 'Free Instant Quote' for car repair. The woman picks up her phone from a table; a RepairSmith notification displays on the smartphone.

6
00:00:22.565 --> 00:00:24.565
A mechanic in a black uniform and blue gloves steps out of the RepairSmith van; the woman in the pink cardigan speaks to the camera.

7
00:00:24.565 --> 00:00:26.565
Text appears: 'Book Today. Get $25 off with code HULU at RepairSmith.com'.

How It Works

Add Your Video

Upload media files or provide a URL. We support all major video formats.

Configure & Generate

Choose configuration options such as audio description (AD) type, language, format, and video category.

Get Descriptions in Text, Audio or Video

Poll for completion or use webhooks.

Quickstart

Get started in 5 minutes

API Reference

Explore all endpoints

Authentication

Secure your requests

Understand the parameters

Set ad_type to choose how descriptions are timed:
  • standard_ad — Fits descriptions into existing no-speech gaps. Video runtime stays the same; some elements may go undescribed if there’s no room.
  • extended_ad — Briefly pauses the video to make room for fuller descriptions. Runtime increases.
See Standard AD vs Extended AD for guidance on choosing.
Set language (BCP-47 code, default en-US) on any generation request to control narration locale. ViddyScribe supports 53 languages including English variants, Spanish, French, German, Hindi, Mandarin, Arabic, and more.See the full list in Languages and Voices.
Set voice on audio and video generation requests to pick the narrator (default Achernar). 31 voices are available (15 female, 16 male). Most cover all 53 languages; one extra Robotic voice is English-only.See the full list in Languages and Voices.
Set custom_instructions to guide the AI for specific terminology, style preferences, or focus areas.
Every generation endpoint returns the text descriptions in the response. Set format (default vtt) to choose how that text is serialized:
  • json — structured array with timestamps and description text
  • vtt — WebVTT subtitles
  • srt — SubRip subtitles
  • edl — Edit Decision List for video editors
The audio endpoint additionally returns a WAV track and the video endpoint additionally returns an MP4. For text-only output, see the text endpoint.

API Endpoints

Upload Endpoints

EndpointMethodDescription
/enterprise/api/upload_mediaPOSTUpload video via File or URL (Input)

Generation Endpoints

EndpointMethodDescription
/enterprise/api/generate_ad_textPOSTGenerate text-only descriptions (Input: media_id, url, file)
/enterprise/api/generate_ad_audioPOSTGenerate audio-only track with text (Input: media_id, url, file)
/enterprise/api/generate_ad_videoPOSTGenerate video with descriptions, and text (Input: media_id, url, file)

Results Endpoint

EndpointMethodDescription
/enterprise/api/get_resultsGETGet results (Input: media_id, url, file)

Need Help?

Support

Get in touch with our support team

API Reference

Explore all available endpoints