Get started with ViddyScribe API in under 5 minutes
Get Your API Key
X-API-Key: vsk_your_api_key_here
Generate Audio Descriptions
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", "format": "json"}'
{
"job_id": "task_abc123xyz",
"status": "queued",
"media_id": "550e8400-e29b-41d4-a716-446655440000"
}
Get Your Results
curl -X GET "https://api.viddyscribe.com/enterprise/api/get_results?job_id=task_abc123xyz" \
-H "X-API-Key: vsk_your_api_key_here"
{
"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"
}
}