Get a Video’s captions

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
422 Unprocessable Entity: body has wrong attributes

Examples

RESPONSE
Content-Type: application/json
[
  {
    "srt_url": "//cdn.vidyard.com/transcriptions/BeQAX/i-UTPAWS.srt",
    "vtt_url": "//cdn.vidyard.com/transcriptions/BeQAX/Yut9l8z4.vtt",
    "txt_url": "//cdn.vidyard.com/transcriptions/BeQAX/Yut9l8z4.txt",
    "language": "en",
    "id": 1011,
    "status": "complete",
    "created_at": 1442297000,
    "updated_at": 1442297001,
    "formatted_language_name": "English (en)",
    "localized_language_name": "English",
    "is_default": true,
    "notes": "Transcription request notes",
    "srt_download_url": "//vidyard.s3.amazonaws.com/transcriptions/BeQAX/i-UTPAWS.srt",
    "vtt_download_url": "//vidyard.s3.amazonaws.com/transcriptions/BeQAX/Yut9l8z4.vtt",
    "txt_download_url": "//vidyard.s3.amazonaws.com/transcriptions/BeQAX/Yut9l8z4.txt",
  },
  {
    "srt_url": "//cdn.vidyard.com/transcriptions/BeQAX/i-UTPAWS.srt",
    "vtt_url": "//cdn.vidyard.com/transcriptions/BeQAX/Yut9l8z4.vtt",
    "txt_url": "//cdn.vidyard.com/transcriptions/BeQAX/Yut9l8z4.txt",
    "language": "fr",
    "id": 1011,
    "status": "complete",
    "created_at": 1442297000,
    "updated_at": 1442297001,
    "formatted_language_name": "Francais (fr)",
    "localized_language_name": "Francais",
    "is_default": false,
    "notes": "",
    "srt_download_url": "//vidyard.s3.amazonaws.com/transcriptions/BeQAX/z-X1PAWS.srt",
    "vtt_download_url": "//vidyard.s3.amazonaws.com/transcriptions/BeQAX/Yut7l8z4.vtt",
    "txt_download_url": "//vidyard.s3.amazonaws.com/transcriptions/BeQAX/Yut9l8z4.txt",
  }
]

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

language
optional

Optional two letter language code used to return the first caption with the matching language code.

Validations:

  • Must be a String

order_by
optional

The attribute to order the list by
Value: Must be one of: name, views, created_at, updated_at

Validations:

  • Must be one of: language, created_at, updated_at.

direction
optional

When the direction to order the list
Only applies when order_by used
Default: asc
Value: Must be one of: asc, desc

Validations:

  • Must be one of: asc, desc.