Skip to main content
POST
/
enterprise
/
api
/
generate_ad_text
Generate AD text (requires media_id)
curl --request POST \
  --url https://api.viddyscribe.com/enterprise/api/generate_ad_text \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "media_id": "550e8400-e29b-41d4-a716-446655440000",
  "format": "json",
  "language": "en-US",
  "video_category": "Auto",
  "ad_type": "extended_ad"
}
'
{
  "job_id": "task_abc123xyz",
  "status": "queued",
  "media_id": "550e8400-e29b-41d4-a716-446655440000"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Obtain from your team admin.

Example: X-API-Key: vsk_abc123def456ghi789jkl012mno345pqr678stu901vwx234yz

Body

application/json
​
media_id
string<uuid>
required

Media ID from upload_media

​
format
enum<string>
default:json

Output format for descriptions

Available options:
json,
vtt,
edl
​
language
enum<string>
default:en-US

Target language (BCP-47 format)

Available options:
en-US,
en-GB,
en-AU,
en-IN,
es-ES,
es-US,
fr-FR,
fr-CA,
de-DE,
it-IT,
pt-BR,
ja-JP,
ko-KR,
cmn-CN,
ar-XA,
hi-IN,
bn-IN,
da-DK,
fi-FI,
gu-IN,
id-ID,
kn-IN,
ml-IN,
mr-IN,
nb-NO,
nl-NL,
nl-BE,
pl-PL,
ru-RU,
sv-SE,
sw-KE,
ta-IN,
te-IN,
th-TH,
tr-TR,
uk-UA,
ur-IN,
vi-VN
Example:

"en-US"

​
video_category
enum<string>
default:Auto

Video category for optimized descriptions

Available options:
Auto,
Educational Lecture,
Documentary,
Narrative Story,
Social Media,
Tutorial/How-To,
Vlog,
Commercial/Advertisement,
News,
Entertainment,
Home Video,
Video Call
​
ad_type
enum<string>
default:extended_ad

Audio description type

Available options:
extended_ad,
standard_ad
​
custom_instructions
string

Optional custom instructions for AI

Response

Job created successfully

​
job_id
string

Unique job identifier for tracking

​
status
enum<string>

Initial job status

Available options:
queued
​
media_id
string<uuid>

Media being processed