Skip to main content
GET
/
enterprise
/
api
/
get_upload_status
Get signed upload status
curl --request GET \
  --url https://api.viddyscribe.com/enterprise/api/get_upload_status \
  --header 'X-API-Key: <api-key>'
{
  "media_id": "550e8400-e29b-41d4-a716-446655440000",
  "canonical_media_id": "550e8400-e29b-41d4-a716-446655440000",
  "upload_status": "completed",
  "duration_seconds": 45.5,
  "frame_rate": 30
}

Documentation Index

Fetch the complete documentation index at: https://docs.viddyscribe.com/llms.txt

Use this file to discover all available pages before exploring further.

Usage Example

Poll this endpoint after notify_upload_complete until the upload has finished verification and the media is ready for generation.
curl "https://api.viddyscribe.com/enterprise/api/get_upload_status?media_id=550e8400-e29b-41d4-a716-446655440000&gcs_path=users/user_123/videos/video.mp4" \
  -H "X-API-Key: YOUR_API_KEY"

Authorizations

X-API-Key
string
header
required

API key for authentication. Obtain from your team admin.

Example: X-API-Key: vsk_abc123def456ghi789jkl012mno345pqr678stu901vwx234yz

Query Parameters

media_id
string<uuid>
required

Media ID returned by upload_media

gcs_path
string

Optional storage path returned by upload_media; helps recover the canonical media if deduplication occurred

Response

Upload status returned successfully

media_id
string<uuid>

Original media ID provided by the client

canonical_media_id
string<uuid>

Canonical media ID to use for generation

upload_status
string

Current verification status for the uploaded media

duration_seconds
number | null

Video duration in seconds when available

frame_rate
number | null

Video frame rate (fps) when available