Skip to main content

​
Base URL

https://api.viddyscribe.com

​
Authentication

All API requests require an API key passed in the X-API-Key header. 
X-API-Key: vsk_your_api_key_here

​
Endpoints

​
Upload Endpoints

Upload Media File

Upload video file (multipart/form-data)

Upload from URL

Upload video from URL (application/json)

​
Text Generation Endpoints

Generate Text

Generate text (requires media_id)

From URL

Upload from URL and generate text

From File

Upload file and generate text

​
Audio Generation Endpoints

Generate Audio

Generate audio track (requires media_id)

From URL

Upload from URL and generate audio

From File

Upload file and generate audio

​
Video Generation Endpoints

Generate Video

Generate video (requires media_id)

From URL

Upload from URL and generate video

From File

Upload file and generate video

​
Results Endpoint

Get Results

Poll for job results and download outputs

​
Quick Example

1

Upload

curl -X POST https://api.viddyscribe.com/enterprise/api/upload_media \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@video.mp4"
2

Generate

curl -X POST https://api.viddyscribe.com/enterprise/api/generate_ad_video \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"media_id": "MEDIA_ID", "language": "en-US"}'
3

Get Results

curl "https://api.viddyscribe.com/enterprise/api/get_results?job_id=JOB_ID" \
  -H "X-API-Key: YOUR_API_KEY"

​
Supported Languages

English (US, GB, AU, IN) • Spanish (ES, US) • French (FR, CA) • German • Italian • Portuguese (BR) • Japanese • Korean • Chinese • Arabic • Hindi • Bengali • Bulgarian • Croatian • Czech • Danish • Dutch (NL, BE) • Estonian • Finnish • Greek • Gujarati • Hebrew • Hungarian • Indonesian • Kannada • Latvian • Lithuanian • Malayalam • Marathi • Norwegian • Polish • Punjabi (India) • Romanian • Russian • Serbian (Cyrillic) • Slovak • Slovenian • Swedish • Swahili • Tamil • Telugu • Thai • Turkish • Ukrainian • Urdu • Vietnamese

​
Video Categories

Auto • Educational Lecture • Educational Kids • Government Meeting • Documentary • Narrative Story • Social Media • Tutorial/How-To • Vlog • Commercial/Advertisement • News • Entertainment • Home Video • Video Call

​
Output Formats

FormatDescription
jsonStructured data with timestamps
vttWebVTT subtitle format
edlEdit Decision List for video editors
videoComplete MP4 with audio descriptions

​
Error Codes

CodeDescription
400Bad request - invalid parameters
401Unauthorized - invalid API key
403Forbidden - plan restriction or input limit
404Not found - media or job not found
409Conflict - media is not ready for generation or upload verification failed
415Unsupported media type - uploaded media is not a valid video
429Too many requests - rate, queue, concurrency, or plan limit exceeded
500Internal server error

​
Common Error Payloads

ErrorHTTP StatusDescription
no_video_stream415The uploaded file contains audio only or otherwise has no video stream. Upload a file with at least one video stream.
video_too_long403The submitted video exceeds the maximum duration allowed by the current plan.
file_too_large403The submitted file exceeds the maximum file size allowed by the current plan.
upload_not_ready409Returned in the code field when generation is requested for media whose upload verification is still in progress. Retry shortly.
upload_failed409Returned in the code field when generation is requested for media whose upload verification failed. Re-upload the media and try again.
plan_limit_exceeded429The current team allocation has been exhausted.
concurrency_limit_exceeded429Too many concurrent submissions are being validated for the current team. Retry after a short delay.
queue_limit_exceeded429Too many jobs are already queued for the current team allocation. Wait for some jobs to complete before submitting more.
rate_limit_exceeded429Too many requests for the current team allocation. Retry after the returned delay.

​
Rate Limits

Limits are enforced per team across all API keys. Enterprise plans can request custom allocations; contact support if you need higher throughput.

​
Rate Limit Exceeded Response

When you exceed the rate limit, you’ll receive a 429 Too Many Requests response: 
{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Please try again later.",
  "limit": 50,
  "remaining": 0,
  "reset": 1696272000,
  "retry_after": 15
}
The retry_after field indicates how many seconds to wait before retrying.

​
Need Help?

Support

Email our team

Dashboard

View usage