> ## 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.

# Introduction

> ViddyScribe Enterprise API

ViddyScribe supports two audio description types, each with different output formats:

| AD Type                                                          | Outputs            |
| ---------------------------------------------------------------- | ------------------ |
| **Standard AD** (no pauses) descriptions placed in dialogue gaps | Text, Audio, Video |
| **Extended AD** (with pauses) descriptions added with pauses     | Text, Video        |

For a deeper breakdown of when to choose each mode, see [Standard AD vs Extended AD](/help/standard-vs-extended-ad).

<Tabs>
  <Tab title="Standard AD">
    <Columns cols={2}>
      <Card title="Input Video">
        <video controls poster="/assets/media-original-thumbnail-15s.jpg" style={{ width: '100%', aspectRatio: '16 / 9', objectFit: 'cover', display: 'block' }}>
          <source src="https://mintcdn.com/viddy/VGrhtVtaRK24GBp0/assets/media.mp4?fit=max&auto=format&n=VGrhtVtaRK24GBp0&q=85&s=3155392288838d52af8dd04c26a876cd" type="video/mp4" data-path="assets/media.mp4" />

          Your browser does not support the video tag.
        </video>
      </Card>

      <Card title="Output AD Video">
        <video controls poster="/assets/media-standard-ad-thumbnail-15s.jpg" style={{ width: '100%', aspectRatio: '16 / 9', objectFit: 'cover', display: 'block' }}>
          <source src="https://mintcdn.com/viddy/VGrhtVtaRK24GBp0/assets/media_sad.mp4?fit=max&auto=format&n=VGrhtVtaRK24GBp0&q=85&s=35b0004f11ecd7320ee211eb9789b794" type="video/mp4" data-path="assets/media_sad.mp4" />

          Your browser does not support the video tag.
        </video>
      </Card>
    </Columns>

    <Card title="Output AD Audio">
      <video controls preload="metadata" style={{ width: '100%', height: '54px', display: 'block' }}>
        <source src="https://mintcdn.com/viddy/VGrhtVtaRK24GBp0/assets/media_sad_audio.mp3?fit=max&auto=format&n=VGrhtVtaRK24GBp0&q=85&s=8fa27fa9a41d597af8aab4742c94ce33" type="audio/mpeg" data-path="assets/media_sad_audio.mp3" />

        Your browser does not support audio playback. <a href="/assets/media_sad_audio.mp3">Download the audio</a>.
      </video>
    </Card>

    <Card title="Output AD Text (VTT)">
      <div style={{ maxHeight: '320px', overflowY: 'auto' }}>
        ```vtt theme={null}
        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'.
        ```
      </div>
    </Card>
  </Tab>

  <Tab title="Extended AD">
    <Columns cols={2}>
      <Card title="Input Video">
        <video controls poster="/assets/media-original-thumbnail-15s.jpg" style={{ width: '100%', aspectRatio: '16 / 9', objectFit: 'cover', display: 'block' }}>
          <source src="https://mintcdn.com/viddy/VGrhtVtaRK24GBp0/assets/media.mp4?fit=max&auto=format&n=VGrhtVtaRK24GBp0&q=85&s=3155392288838d52af8dd04c26a876cd" type="video/mp4" data-path="assets/media.mp4" />

          Your browser does not support the video tag.
        </video>
      </Card>

      <Card title="Output AD Video">
        <video controls poster="/assets/media-extended-ad-thumbnail-50s.jpg" style={{ width: '100%', aspectRatio: '16 / 9', objectFit: 'cover', display: 'block' }}>
          <source src="https://mintcdn.com/viddy/VGrhtVtaRK24GBp0/assets/media_ead.mp4?fit=max&auto=format&n=VGrhtVtaRK24GBp0&q=85&s=911e4e0363f535d4521c6c8d3934605b" type="video/mp4" data-path="assets/media_ead.mp4" />

          Your browser does not support the video tag.
        </video>
      </Card>
    </Columns>

    <Card title="Output AD Text (VTT)">
      <div style={{ maxHeight: '320px', overflowY: 'auto' }}>
        ```vtt theme={null}
        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'.
        ```
      </div>
    </Card>
  </Tab>
</Tabs>

## How It Works

<Steps>
  <Step title="Add Your Video" icon="upload">
    Upload media files or provide a URL. We support all major video formats.
  </Step>

  <Step title="Configure & Generate" icon="sliders">
    Choose configuration options such as audio description (AD) type, language, format, and video category.
  </Step>

  <Step title="Get Descriptions in Text, Audio or Video" icon="download">
    Poll for completion or use webhooks.
  </Step>
</Steps>

## Quick Links

<CardGroup cols={3}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Get started in 5 minutes
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/overview">
    Explore all endpoints
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Secure your requests
  </Card>
</CardGroup>

## Understand the parameters

<AccordionGroup>
  <Accordion title="AD Type (ad_type)" icon="volume-high">
    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](/help/standard-vs-extended-ad) for guidance on choosing.
  </Accordion>

  <Accordion title="Language (language)" icon="globe">
    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](/api-reference/voices).
  </Accordion>

  <Accordion title="Voice (voice)" icon="microphone">
    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](/api-reference/voices).
  </Accordion>

  <Accordion title="Custom Instructions (custom_instructions)" icon="wand-magic-sparkles">
    Set `custom_instructions` to guide the AI for specific terminology, style preferences, or focus areas.
  </Accordion>

  <Accordion title="Output Format (format)" icon="file-export">
    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](/api-reference/processing/generate-audio-description-audio) additionally returns a WAV track and the [video endpoint](/api-reference/processing/generate-audio-description-video) additionally returns an MP4. For text-only output, see the [text endpoint](/api-reference/processing/generate-audio-description-text).
  </Accordion>
</AccordionGroup>

## API Endpoints

### Upload Endpoints

| Endpoint                                                            | Method | Description                          |
| ------------------------------------------------------------------- | ------ | ------------------------------------ |
| [`/enterprise/api/upload_media`](/api-reference/media/upload-media) | POST   | Upload video via File or URL (Input) |

### Generation Endpoints

| Endpoint                                                                                          | Method | Description                                                              |
| ------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------ |
| [`/enterprise/api/generate_ad_text`](/api-reference/processing/generate-audio-description-text)   | POST   | Generate text-only descriptions (Input: media\_id, url, file)            |
| [`/enterprise/api/generate_ad_audio`](/api-reference/processing/generate-audio-description-audio) | POST   | Generate audio-only track with text (Input: media\_id, url, file)        |
| [`/enterprise/api/generate_ad_video`](/api-reference/processing/generate-audio-description-video) | POST   | Generate video with descriptions, and text (Input: media\_id, url, file) |

### Results Endpoint

| Endpoint                                                                | Method | Description                               |
| ----------------------------------------------------------------------- | ------ | ----------------------------------------- |
| [`/enterprise/api/get_results`](/api-reference/results/get-job-results) | GET    | Get results (Input: media\_id, url, file) |

## Need Help?

<CardGroup cols={2}>
  <Card title="Support" icon="life-ring" href="/help/contact">
    Get in touch with our support team
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/overview">
    Explore all available endpoints
  </Card>
</CardGroup>
