Cover image
Get the channel cover image
GET https://api.video.ibm.com/channels/{channel_id}/design/cover.json
Success response
Upon success a response with HTTP status “200 OK” is returned with the following key-value structures.
| KEY | TYPE | DESCRIPTION |
|---|---|---|
image | string | Cover image URL |
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 401 Unauthorized | The provided access token is missing, revoked, expired or malformed | |
| 404 Not Found | not_found | Channel not found |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Upload cover image
POST https://api.video.ibm.com/channels/{channel_id}/design/cover.json
Request
The image must be passed in the HTTP body as binary data.
- The image dimensions must be: 2560 x 852 px
- Supported image types:
- image/jpeg
- image/png
- image/gif
- Maximum image size: 5 MB
CURL example:
curl --location --request POST 'https://git.api.video.ibm.com.lh/channels/1234/design/cover.json' \--header 'Authorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950' \--header 'Content-Type: image/png' \--data-binary '@/path/to/your/new/cover/image.png'
Note that the token in the above call is only an example.
Success response
Upon success the response body is empty with an HTTP Status code of 204.
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 400 Bad Request | bad_request | Invalid input |
| 401 Unauthorized | invalid_token | The provided access token is missing, revoked, expired or malformed |
| 403 Unauthorized | lack_of_ownership | The provided access token could not access the given channel |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Delete cover image
DELETE https://api.video.ibm.com/channels/{channel_id}/design/cover.json
Success response
Upon success, a response with HTTP status “204 No Content” is returned.
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 401 Unauthorized | The provided access token is missing, revoked, expired or malformed | |
| 403 Forbidden | lack_of_ownership | The API user is not allowed to manage the given channel |
| 404 Not Found | not_found | Channel not found |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |