Skip to main content
GET
/
enterprise
/
api
/
get_results
Get job results
curl --request GET \
  --url https://api.viddyscribe.com/enterprise/api/get_results \
  --header 'X-API-Key: <api-key>'
{
  "job_id": "task_abc123xyz",
  "status": "queued",
  "media_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-30T08:00:00Z",
  "updated_at": "2025-09-30T08:00:00Z"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Obtain from your team admin.

Example: X-API-Key: vsk_abc123def456ghi789jkl012mno345pqr678stu901vwx234yz

Query Parameters

​
job_id
string
required

Job ID returned from generate_ad_text, generate_ad_video, or generate_ad_audio

Response

Job status retrieved successfully

​
job_id
string

Job identifier

​
status
enum<string>

Current job status

Available options:
queued,
processing,
done,
failed
​
media_id
string<uuid>

Media being processed

​
created_at
string<date-time>

Job creation timestamp

​
updated_at
string<date-time>

Job last update timestamp

​
video_signed_url
string<uri>

Signed URL to download result (video/audio jobs, expires in 15 minutes)

​
audio_signed_url
string<uri>

Signed URL to download audio track (standard_ad video jobs only, expires in 15 minutes)

​
output
object

Output with generated descriptions (if available). Format depends on requested format:

  • json: Returns segments array
  • vtt/edl: Returns format and content string
​
error
string

Stable, machine-readable error code (only present when status=failed). Switch on this value to handle failures programmatically. See Job Failure Errors for the full list of codes and their meanings.

​
message
string

Human-readable error description (only present when status=failed). Suitable for display in your UI.