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

Get status of caption VTT content

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

Examples

RESPONSE
Code: 200
Content-Type: application/json
{
  "status": "in_progress"
}

RESPONSE
Code: 302
Location: https://some-url.com/api/v1/captions/:id/content

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

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:

indicates the intermediate status of the caption

Param name	Description
status required , nil allowed	The current state of the caption Validations: Must be one of: captioning, complete, draft, error, initializing, in_process, in_progress, published, saving, transcribing.

Code: 302

Description:

indicates the location where the updated caption content can be pulled

Param name	Description

Code: 404

Description:

Message returned when the caption could not be found

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