Skip to main contentIBM Video Streaming Developers

Watson Live Captioning

Check if Watson Live Captioning is enabled

GET https://api.video.ibm.com/channels/{channelId}/settings/watson-live-captioning.json

Success response

Upon success a response with HTTP status “200 OK” is returned with the following key-value pairs.

KEYTYPEDESCRIPTION
is_enabledbooleanWatson Live Captioning is enabled

Example of a success response:

{
"is_enabled": true,
}

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
401 Unauthorizedinvalid_tokenThe provided access token is missing, revoked, expired or malformed
402 Payment requiredpayment_requiredThe required benefit is missing from the channel
403 Unauthorizedlack_of_ownershipThe provided access token could not access the given channel
404 Not Foundnot_foundChannel was not found
405 Method Not Allowedmethod_not_allowedThe given HTTP method is not allowed for the endpoint
429 Too Many Requeststoo_many_requestsRate limit exceeded (Read more)
500 Server errorThere is a temporary error on the server which makes it impossible to serve the request
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

Turn on/off Watson Live Captioning

PUT https://api.video.ibm.com/channels/{channelId}/settings/watson-live-captioning.json

Parameters

KEYTYPEIMPORTANCEDESCRIPTION
enablestringREQUIREDtrue/false

The Content-Type of the request should be application/x-www-form-urlencoded.

Example of the request:

POST /channels/1234/settings/watson-live-captioning.json HTTP/1.1
Host: api.video.ibm.com
Authorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950
Content-Type: application/x-www-form-urlencoded
enable=true

Success response

Upon success the response body is empty with an HTTP Status code of 204.

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
400 Bad requestform_errorThe provided request body is invalid
401 Unauthorizedinvalid_tokenThe provided access token is missing, revoked, expired or malformed
402 Payment requiredpayment_requiredThe required benefit is missing from the channel
403 Unauthorizedlack_of_ownershipThe provided access token could not access the given channel
404 Not Foundnot_foundChannel was not found
405 Method Not Allowedmethod_not_allowedThe given HTTP method is not allowed for the endpoint
429 Too Many Requeststoo_many_requestsRate limit exceeded (Read more)
500 Server errorThere is a temporary error on the server which makes it impossible to serve the request
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request