Media Service

Get audio master file (download)

get
https://api.typeform.com/media/audios/{id}/master

Retrieves the processed master audio file URL. This endpoint should be polled to check the transcoding status.

Download Process:

  1. After requesting the master file (POST), poll this endpoint to check the transcoding status
  2. When status is "ready", the url field contains the download URL for the processed audio
  3. Use the returned URL to download the audio file

Status Values:

  • none: Audio master is not yet requested
  • preparing: Audio master is being prepared
  • ready: Audio is ready for download (URL provided)

Polling Recommendations:

  • Poll every 2-3 seconds initially
  • After 30 seconds, increase polling interval to 5-10 seconds
  • Stop polling once status is ready or errored

Note: The download URL is only valid for 24 hours and can be regenerated by calling the POST endpoint again.

Request

Path Parameters

id
string, required

Unique ID for the audio returned from the upload endpoint

Responses

Status

200 Master audio status and URL retrieved successfully

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 Audio 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