Professional Captioning
This endpoint lists caption requests. It works both with auth token and the captioning service auth headers.
Provider of the caption. The only option is "professional"
Status of the caption request. The only possible value now is "requested"
List of caption requests
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
Invalid parameters.
GET /api/public/v1/caption_file_requests HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"caption_file_requests": []
}This endpoint should be used to update a pending caption file request. Each request can be updated once with either fulfilled or failed status.
The id of the caption file request to be updated.
Result of the file request.
In case the caption creation was not successful you can provide some detail why it could not be completed.
The file to be uploaded. The supported file extension is .srt!
The results are successfully saved.
One ore more required parameters are missing from the request.
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
Invalid parameters.
PATCH /api/public/v1/caption_file_requests/{caption_file_request_id} HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 62
{
"status": "processing",
"message": "text",
"caption_file": "text"
}No content
The list of active service types user has permission to.
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
There is no active captioning service for the account.
GET /api/public/v1/captioning_service_types HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"captioning_service_types": [
{
"id": 1,
"key": "text",
"label": "text",
"is_asr": true,
"description": "text",
"languages": [
"text"
]
}
]
}The endpoint will insert or update a service type for a captioning service. This endpoint only supports IETF language code
machine readable “id” that will be included with caption file requests when a CaptionService lists available requests.
An object describing the service type
IETF language code
The service type has been updated successfully
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
There is no active captioning service for the account.
PUT /api/public/v1/captioning_service_types/{key} HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 72
{
"label": "text",
"description": "text",
"is_asr": true,
"languages": [
"text"
]
}{
"captioning_service_types": [
{
"id": 1,
"key": "text",
"label": "text",
"is_asr": true,
"description": "text",
"languages": [
"text"
]
}
]
}This endpoint will delete a service type for a captioning service and will remove the associated captioning roles from it.
machine readable “id” that will be included with caption file requests when a CaptionService lists available requests.
The service type has been deleted successfully
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
There is no active captioning service for the account or the service type does not exist.
DELETE /api/public/v1/captioning_service_types/{key} HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?