GET https://api.vidyard.com/dashboard/v1/audio_tracks/:id
Get an audio track's status

Retrieve an audio track’s status, returning one of processing (still being processed), complete (ready to play) or error (failed; error_code and error_message say why). error_code is one of:

• duration_mismatch: the audio’s length is more than 2 seconds off the video’s.
• unreadable: the file couldn’t be read as WAV audio (empty, corrupted, or not audio only).
• encoding_failed: the file could not be downloaded (e.g. an expired link) or processed.
• processing_timeout: processing took too long.

To retry a failed track, send the file again with POST /v1/videos/:video_id/audio_tracks. published says whether viewers can select the track; a newly completed track is unpublished.

Supported Formats

json

Errors

Code	Description
401	Unauthorized: auth_token omitted or authentication failed
403	Forbidden: This action cannot be performed
404	No audio track exists with that id, or it is being deleted

Examples

RESPONSE
Code: 200
Content-Type: application/json
{
  "id": 123,
  "video_id": 456,
  "language": "fr",
  "status": "error",
  "error_code": "duration_mismatch",
  "error_message": "The audio's length doesn't match the video's length (it must be within 2 seconds).",
  "published": false
}

Params

Param name	Description
auth_token optional	API token needed to authorize requests This can appear as an attribute in the body of the request or the query parameters on the URL Validations: Must be a String

Returns

Code: 200

Description:

The requested audio track

Param name	Description
id required	The audio track id Validations: Parameter has to be Integer.
video_id required	The id of the video the track belongs to Validations: Parameter has to be Integer.
language required	BCP47 media language code for the track Validations: Must be a String
status required	processing until the track is playable, complete once it is, or error if it failed Validations: Must be one of: processing, complete, error.
error_code required , nil allowed	Machine-readable failure reason; null unless status is error Validations: Must be a String
error_message required , nil allowed	Readable failure reason; null unless status is error Validations: Must be a String
published required	Whether viewers can select the track Validations: Must be one of: true, false, 1, 0.