games.avatars.prepareCustomAvatarUpload
Description
Prepares a custom avatar image upload.
Complete upload with rivet.api.cloud#CompleteCustomAvatarUpload
.
Code Examples
Request
POST
https://api.rivet.gg/cloud/games/{game_id}/prepare# Write the request body to body.json before running
curl -X POST -d '@body.json' 'https://api.rivet.gg/cloud/games/{game_id}/prepare'
Request Parameters
game_id
Path parameter, required
Request Body
content_length
integer
(required)
Unsigned 64 bit integer.
mime
string
The MIME type of the custom avatar.
path
string
(required)
The path/filename of the custom avatar.
Response Body
presigned_request
object
(required)
A presigned request used to upload files. Upload your file to the given URL via a PUT request.
presigned_request.byte_offset
integer
(required)
The byte offset for this multipart chunk. Always 0 if not a multipart upload.
presigned_request.content_length
integer
(required)
Expected size of this upload.
presigned_request.path
string
(required)
The name of the file to upload. This is the same as the one given in the upload prepare file.
presigned_request.url
string
(required)
The URL of the presigned request for which to upload your file to.
upload_id
string
(required)