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
required path parameter
Request Body
content_length
required integer
Unsigned 64 bit integer.
mime
string
The MIME type of the custom avatar.
path
required string
The path/filename of the custom avatar.
Response Body
presigned_request
required object
A presigned request used to upload files. Upload your file to the given URL via a PUT request.
byte_offset
required integer
The byte offset for this multipart chunk. Always 0 if not a multipart upload.
content_length
required integer
Expected size of this upload.
path
required string
The name of the file to upload. This is the same as the one given in the upload prepare file.
url
required string
The URL of the presigned request for which to upload your file to.
upload_id
required string