Endpoints responsible for interacting with video captions, either in the context of a video or an individual caption
Given a valid video ID, and optional filtering and sorting parameters, retrieves the captions associated with the video that satisfy the parameters
| 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 |
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",
}
]
RESPONSE
Code: 404
Content-Type: application/json
{
"error": "404: No video exists with that id"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
language optional |
two letter language code used to return the first caption with the matching language code Validations:
|
|
order_by optional |
The attribute to order the list by Validations:
|
|
direction optional |
Given an valid order_by value, determines the direction to order the list Validations:
|
All captions associated with the video given filtering and sorting options applied (if any)
| Param name | Description |
|---|---|
|
srt_url required |
The URI of the SRT-formatted version of the caption Validations:
|
|
vtt_url required |
The URI of the VTT-formatted version of the caption Validations:
|
|
txt_url required |
The URI of the TXT-formatted version of the caption Validations:
|
|
language required |
The language locale code indicating the language the caption is in Validations:
|
|
id required |
The internal ID of the caption Validations:
|
|
status required , nil allowed |
The current state of the caption Validations:
|
|
created_at required |
The timestamp when the caption was created Validations:
|
|
updated_at required |
The timestamp when the caption was last updated Validations:
|
|
formatted_language_name required |
The name of the language in which the caption was formatted Validations:
|
|
localized_language_name required |
The name of the language in which the caption was localized Validations:
|
|
is_default required |
Indicates whether or not this is the default caption for the associated video Validations:
|
|
notes required |
Additional notes created for the user about the caption Validations:
|
|
srt_download_url required |
A fully qualified URL from which the SRT-formatted version of the caption can be downloaded Validations:
|
|
vtt_download_url required |
A fully qualified URL from which the VTT-formatted version of the caption can be downloaded Validations:
|
|
txt_download_url required |
A fully qualified URL from which the TXT-formatted version of the cpation can be downloaded Validations:
|
|
creator_type required |
Indicates if the caption was created automatically or manually Validations:
|
A message indicating why the caption could not be created
| Param name | Description |
|---|---|
|
error required |
A contextual error message when a request could not be completed Validations:
|
The URL specified in srt_url or vtt_url will be fetched and the response body used as the content of the SRT or VTT file respectively. If no such URLs were specified, then an empty VTT file will be created instead. If both are provided, we will default to the srt_url.
Warning: It is the responsibility of the caller to verify if the SRT or VTT was fetched successfully. A successful fetch will leave the caption in a success state, otherwise it will be in an error state with an appropriate message.
| 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 |
RESPONSE
Code: 201
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": "in_progress",
"formatted_text": "The quick brown fox\njumped over the lazy dog.",
"plain_text": "The quick brown fox jumped over the lazy dog.",
"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",
}
RESPONSE
Code: 404
Content-Type: application/json
{
"error": "404: No video exists with that id"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
srt_url optional |
SRT URL Validations:
|
|
vtt_url optional |
VTT URL Validations:
|
|
language optional |
Language of caption Validations:
|
|
source_language optional |
Language of caption source Validations:
|
|
is_default optional |
Set the default caption for the video Validations:
|
|
creator_type optional , nil allowed |
Type of creator of captions Validations:
|
The newly added caption for the video
| Param name | Description |
|---|---|
|
srt_url required |
The URI of the SRT-formatted version of the caption Validations:
|
|
vtt_url required |
The URI of the VTT-formatted version of the caption Validations:
|
|
txt_url required |
The URI of the TXT-formatted version of the caption Validations:
|
|
language required |
The language locale code indicating the language the caption is in Validations:
|
|
id required |
The internal ID of the caption Validations:
|
|
status required , nil allowed |
The current state of the caption Validations:
|
|
created_at required |
The timestamp when the caption was created Validations:
|
|
updated_at required |
The timestamp when the caption was last updated Validations:
|
|
formatted_language_name required |
The name of the language in which the caption was formatted Validations:
|
|
localized_language_name required |
The name of the language in which the caption was localized Validations:
|
|
is_default required |
Indicates whether or not this is the default caption for the associated video Validations:
|
|
notes required |
Additional notes created for the user about the caption Validations:
|
|
srt_download_url required |
A fully qualified URL from which the SRT-formatted version of the caption can be downloaded Validations:
|
|
vtt_download_url required |
A fully qualified URL from which the VTT-formatted version of the caption can be downloaded Validations:
|
|
txt_download_url required |
A fully qualified URL from which the TXT-formatted version of the cpation can be downloaded Validations:
|
|
creator_type required |
Indicates if the caption was created automatically or manually Validations:
|
A message indicating why the caption could not be created
| Param name | Description |
|---|---|
|
error required |
A contextual error message when a request could not be completed Validations:
|
Get a caption by id
| 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 |
RESPONSE
Code: 200
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": "in_progress",
"formatted_text": "The quick brown fox\njumped over the lazy dog.",
"plain_text": "The quick brown fox jumped over the lazy dog.",
"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",
}
RESPONSE
Code: 404
Content-Type: application/json
{
"error": "404: No caption exists with that id"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
The requested caption
| Param name | Description |
|---|---|
|
srt_url required |
The URI of the SRT-formatted version of the caption Validations:
|
|
vtt_url required |
The URI of the VTT-formatted version of the caption Validations:
|
|
txt_url required |
The URI of the TXT-formatted version of the caption Validations:
|
|
language required |
The language locale code indicating the language the caption is in Validations:
|
|
id required |
The internal ID of the caption Validations:
|
|
status required , nil allowed |
The current state of the caption Validations:
|
|
created_at required |
The timestamp when the caption was created Validations:
|
|
updated_at required |
The timestamp when the caption was last updated Validations:
|
|
formatted_language_name required |
The name of the language in which the caption was formatted Validations:
|
|
localized_language_name required |
The name of the language in which the caption was localized Validations:
|
|
is_default required |
Indicates whether or not this is the default caption for the associated video Validations:
|
|
notes required |
Additional notes created for the user about the caption Validations:
|
|
srt_download_url required |
A fully qualified URL from which the SRT-formatted version of the caption can be downloaded Validations:
|
|
vtt_download_url required |
A fully qualified URL from which the VTT-formatted version of the caption can be downloaded Validations:
|
|
txt_download_url required |
A fully qualified URL from which the TXT-formatted version of the cpation can be downloaded Validations:
|
|
creator_type required |
Indicates if the caption was created automatically or manually Validations:
|
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:
|
Given a valid caption id, will update the caption using the supplied parameters and values
Warning: Even though the server returns a 200 response, in general, if the response object status indicates it is pending or in progress, it is not safe to assume that the caption file is ready, and so you should use the content status API endpoint to verify it is ready before trying to use it.
| 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 |
RESPONSE
Code: 200
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": "pending",
"formatted_text": "The quick brown fox\njumped over the lazy dog.",
"plain_text": "The quick brown fox jumped over the lazy dog.",
"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",
}
RESPONSE
Code: 404
Content-Type: application/json
{
"error": "404: No caption exists with that id"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
vtt_url optional |
The URI of a VTT file that is being used to update the captions content (if any) Validations:
|
|
language optional |
A valid language locale code indicating the new language of the caption (if any) Validations:
|
|
content optional |
A plaintext representation of the captions content in VTT format (if any) Validations:
|
|
error_message optional |
Set error message of caption Validations:
|
|
is_default optional |
Indicates whether or not this is default caption for the video (if changed) Validations:
|
|
creator_type optional , nil allowed |
Set the new type of the creator of the caption (if changed) Validations:
|
The updated caption for the video
| Param name | Description |
|---|---|
|
srt_url required |
The URI of the SRT-formatted version of the caption Validations:
|
|
vtt_url required |
The URI of the VTT-formatted version of the caption Validations:
|
|
txt_url required |
The URI of the TXT-formatted version of the caption Validations:
|
|
language required |
The language locale code indicating the language the caption is in Validations:
|
|
id required |
The internal ID of the caption Validations:
|
|
status required , nil allowed |
The current state of the caption Validations:
|
|
created_at required |
The timestamp when the caption was created Validations:
|
|
updated_at required |
The timestamp when the caption was last updated Validations:
|
|
formatted_language_name required |
The name of the language in which the caption was formatted Validations:
|
|
localized_language_name required |
The name of the language in which the caption was localized Validations:
|
|
is_default required |
Indicates whether or not this is the default caption for the associated video Validations:
|
|
notes required |
Additional notes created for the user about the caption Validations:
|
|
srt_download_url required |
A fully qualified URL from which the SRT-formatted version of the caption can be downloaded Validations:
|
|
vtt_download_url required |
A fully qualified URL from which the VTT-formatted version of the caption can be downloaded Validations:
|
|
txt_download_url required |
A fully qualified URL from which the TXT-formatted version of the cpation can be downloaded Validations:
|
|
creator_type required |
Indicates if the caption was created automatically or manually Validations:
|
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:
|
Get status of caption VTT content
| 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 |
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"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
indicates the intermediate status of the caption
| Param name | Description |
|---|---|
|
status required , nil allowed |
The current state of the caption Validations:
|
indicates the location where the updated caption content can be pulled
| Param name | 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:
|
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.
| 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 |
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
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
The content of the caption
| Param name | Description |
|---|---|
|
content required |
A plaintext representation of the captions content in VTT format Validations:
|
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:
|
Sets the status field of the caption to draft only if the caption is currently in a published or complete state
| 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 |
RESPONSE
Code: 200
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": "draft",
"formatted_text": "The quick brown fox\njumped over the lazy dog.",
"plain_text": "The quick brown fox jumped over the lazy dog.",
"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",
}
RESPONSE
Code: 400
Content-Type: application/json
{
"error": "Caption must be set to 'published', or 'complete' to set it to 'draft'"
}
RESPONSE
Code: 400
Content-Type: application/json
{
"error": "404: No caption exists with that id"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
The updated caption with status set to draft
| Param name | Description |
|---|---|
|
content required |
A plaintext representation of the captions content in VTT format Validations:
|
Message returned when the caption is not currently in a valid state to be marked as draft
| Param name | Description |
|---|---|
|
error required |
A contextual error message when a request could not be completed Validations:
|
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:
|
Sets the status field of the caption to draft only if the caption is currently in a complete or draft state
| 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 |
RESPONSE
Code: 200
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": "published",
"formatted_text": "The quick brown fox\njumped over the lazy dog.",
"plain_text": "The quick brown fox jumped over the lazy dog.",
"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",
}
RESPONSE
Code: 400
Content-Type: application/json
{
"error": "Caption must be set to 'draft', or 'complete' to set it to 'published'"
}
RESPONSE
Code: 400
Content-Type: application/json
{
"error": "404: No caption exists with that id"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
The updated caption with status set to published
| Param name | Description |
|---|---|
|
content required |
A plaintext representation of the captions content in VTT format Validations:
|
Message returned when the caption is not currently in a valid state to be marked as published
| Param name | Description |
|---|---|
|
error required |
A contextual error message when a request could not be completed Validations:
|
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:
|
Delete a caption
| 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 |
RESPONSE
Code: 200
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": "published",
"formatted_text": "The quick brown fox\njumped over the lazy dog.",
"plain_text": "The quick brown fox jumped over the lazy dog.",
"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",
}
RESPONSE
Code: 404
Content-Type: application/json
{
"error": "404: No caption exists with that id"
}
RESPONSE
Code: 500
Content-Type: application/json
{
"error": "Failed to delete caption with id"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
The deleted caption
| Param name | Description |
|---|---|
|
srt_url required |
The URI of the SRT-formatted version of the caption Validations:
|
|
vtt_url required |
The URI of the VTT-formatted version of the caption Validations:
|
|
txt_url required |
The URI of the TXT-formatted version of the caption Validations:
|
|
language required |
The language locale code indicating the language the caption is in Validations:
|
|
id required |
The internal ID of the caption Validations:
|
|
status required , nil allowed |
The current state of the caption Validations:
|
|
created_at required |
The timestamp when the caption was created Validations:
|
|
updated_at required |
The timestamp when the caption was last updated Validations:
|
|
formatted_language_name required |
The name of the language in which the caption was formatted Validations:
|
|
localized_language_name required |
The name of the language in which the caption was localized Validations:
|
|
is_default required |
Indicates whether or not this is the default caption for the associated video Validations:
|
|
notes required |
Additional notes created for the user about the caption Validations:
|
|
srt_download_url required |
A fully qualified URL from which the SRT-formatted version of the caption can be downloaded Validations:
|
|
vtt_download_url required |
A fully qualified URL from which the VTT-formatted version of the caption can be downloaded Validations:
|
|
txt_download_url required |
A fully qualified URL from which the TXT-formatted version of the cpation can be downloaded Validations:
|
|
creator_type required |
Indicates if the caption was created automatically or manually Validations:
|
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:
|
Message returned indicating that the caption could not be deleted
| Param name | Description |
|---|---|
|
error required |
A contextual error message when a request could not be completed Validations:
|