Upload Cover Image
This endpoint enables uploading a cover image to a user's media account.
It supports both direct file uploads and URL-based image fetching, with automatic image conversion.
Uploaded images are resized according to the coverType provided, else default dimensions are used. Aspect ratio is preserved and the image is cropped to fit these dimensions, positioned to the centre.
| coverType | height (px) | width (px) |
|---|---|---|
| default | 1011 | 638 |
| activities | 1011 | 638 |
| music | 1011 | 638 |
| myo | 400 | 520 |
| podcast | 600 | 600 |
| radio | 600 | 600 |
| sfx | 1011 | 638 |
| stories | 1011 | 638 |
Required Scope
user:content:manage
Responses
coverImageobject
mediaIdstring
mediaUrlstring
{
"coverImage": {
"mediaId": "uiM3MMWgQkG_zdd_EYHd93Z2OQSH5Hn069wDGdWANMc",
"mediaUrl": "https://card-content.aws.fooropa.com/1bErAD2CBDPwN88jdjBO7aVSR1OGL5DOq05fyz6PioCs~/pub/uiM3MMWgQkG_zdd_EYHd93Z2OQSH5Hn069wDGdWANMc"
}
}errorobject
codestring
messagestring
{
"error": {
"code": "bad-request",
"message": "A binary image file body or imageUrl param is required"
}
}errorobject
codestring
messagestring
{
"error": {
"code": "forbidden",
"message": "Access to media account denied"
}
}Query Parameters
imageUrlstring
URL of an image to fetch and upload. Required if no file body is provided.
Example
https://picsum.photos/id/237/200/300.jpgautoconvertstring
Whether to automatically convert the image to the specified cover type. Boolean,
Example
truecoverTypestring
The type of cover image to create. This determines the image dimensions.
Example
defaultfilenamestring
Custom filename for the uploaded image.
Example
POST
/media/coverImage/user/me/uploadServer URL: https://api.yotoplay.com
Query Parameters
| KEY | VALUE |
|---|---|
Request Body
curl "https://api.yotoplay.com/media/coverImage/user/me/upload"