Sign In

games.avatars.prepareCustomAvatarUpload

Description

Prepares a custom avatar image upload. Complete upload with rivet.api.cloud#CompleteCustomAvatarUpload.

Code Examples

# 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

  • path
    string

    The path/filename of the custom avatar.

  • mime
    string

    The MIME type of the custom avatar.

  • content_length
    number

    Unsigned 64 bit integer.

Response Body

  • upload_id
    string
  • presigned_request
    object

    A presigned request used to upload files. Upload your file to the given URL via a PUT request.

    • presigned_request.path
      string

      The name of the file to upload. This is the same as the one given in the upload prepare file.

    • presigned_request.url
      string

      The URL of the presigned request for which to upload your file to.

    • presigned_request.byte_offset
      number

      The byte offset for this multipart chunk. Always 0 if not a multipart upload.

    • presigned_request.content_length
      number

      Expected size of this upload.