Skip to main content

​
Generate AD Text

Pick one of the two simple flows below to generate audio description text.

​
1. Using a Video from public URL

Upload from a public URL and generate in one step. 
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 '{
    "input": {
      "type": "url",
      "url": "https://example.com/video.mp4"
    },
    "generation_config": {
      "language": "en-US",
      "ad_type": "extended_ad"
    }
  }'
Response: 
{
  "job_id": "task_abc123xyz",
  "status": "queued",
  "media_id": "550e8400-e29b-41d4-a716-446655440000"
}
Use the job_id to poll get_results for completion.

​
2. Using a Video from local file

Upload a local file and generate 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 "[email protected]" \
  -F 'generation_config={"language": "en-US", "ad_type": "extended_ad"}'
Response: 
{
  "job_id": "task_def456uvw",
  "status": "queued",
  "media_id": "660f9511-f30c-52e5-b827-557766551111"
}
Use the job_id to poll get_results for completion. On success, output contains timestamped descriptions (and optional vtt).

​
Tips

  • Prefer short public URLs where possible.
  • Set language to a BCP‑47 tag like en-US.
  • Use ad_type of extended_ad for fuller descriptions or standard_ad for concise ones.

​
Retrieve Results

Use the job_id from the previous step to fetch results: 
curl -X GET "https://api.viddyscribe.com/enterprise/api/get_results?job_id=TASK_ID" \
  -H "X-API-Key: vsk_your_api_key_here"
Example successful response for text jobs: 
{
  "job_id": "task_abc123xyz",
  "status": "done",
  "output": {
    "language": "en-US",
    "ad_type": "extended_ad",
    "items": [
      { "start": 0.5, "end": 3.1, "text": "A woman in a yellow top sits at a desk with a laptop." },
      { "start": 3.2, "end": 5.9, "text": "She looks at the camera and smiles." }
    ],
    "vtt": "WEBVTT\n\n00:00.500 --> 00:03.100\nA woman in a yellow top sits at a desk with a laptop.\n\n00:03.200 --> 00:05.900\nShe looks at the camera and smiles.\n"
  }
}