Media Service

Request video master file generation

post
https://api.typeform.com/media/videos/{id}/master

Initiates the master file generation process for a video. This should be called after uploading a video file.

Master File Process:

  1. After uploading a video to the upload_url, call this endpoint to start processing
  2. The service will begin generating the master file (high-quality downloadable version)
  3. Use the GET endpoint to poll for status and retrieve the download URL when ready

Note: This endpoint is idempotent - calling it multiple times for the same video will not restart processing.

Request

Path Parameters

id
string, required

Unique ID for the video returned from the upload endpoint

Responses

Status

200 Master file generation request accepted

Schema

status
string
Valid values:nonepreparingready

Current transcoding status:

  • none: No master file has been requested
  • preparing: Upload being prepared
  • ready: Processing complete, media available for download
url
string

Download URL for the processed media file. Only present when status is "ready". This is a temporary signed URL that should be used promptly.

Example

{
  "status": "ready",
  "url": "https://stream.mux.com/video-id/high.mp4?token=signed-token"
}

Status

401 Unauthorized - invalid or missing authentication token

Schema

code
string

Error code identifying the type of error

details
object

Additional error details specific to the error type

message
string

Human-readable error message

Status

404 Video not found

Schema

code
string

Error code identifying the type of error

details
object

Additional error details specific to the error type

message
string

Human-readable error message