GET https://api.vidyard.com/dashboard/v1/captions/:id/content
Get caption VTT content

Given a valid caption id, will return the VTT content for the caption. If the content has been processed, the endpoint will return a 200 with the content in the body. Otherwise, it will return a 404 with message indicating that the caption is still being processed.

Warning: Since the response of this endpoint is dependent on the status of the resource, it is best to consider polling the content status endpoint before attempting to fetch the resource.

Supported Formats

json

Errors

Code	Description
401	Unauthorized: auth_token omitted or authentication failed
403	Forbidden: This action cannot be performed
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
404	Not Found: The requested resource could not be found
400	Bad Request: body has wrong syntax or unable to handle request

Examples

RESPONSE
Code: 200
Content-Type: application/json
{
  "content":"WEBVTT\n\n00:00:00.000 --> 00:00:02.000\nThis is a test caption.\n"
}

RESPONSE
Code: 404
Content-Type: application/json
{
  "error": "404: No caption exists with that id"
}

RESPONSE
Code: 404
Content-Type: application/json
{
  "error": "The requested VTT file is still processing
}

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 content of the caption

Param name	Description
content required	A plaintext representation of the captions content in VTT format Validations: Must be a String

Code: 404

Description:

Message returned when the caption content is still processing

Param name	Description
error required	A contextual error message when a request could not be completed Validations: Must be a String