v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Create Avatar

Create an avatar. It's possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

POST
/avatars

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Request Body

assetUrl?string
assetVersion?string
platform?string

This can be standalonewindows or android, but can also pretty much be any random Unity verison such as 2019.2.4-801-Release or 2019.2.2-772-Release or even unknownplatform.

created_at?string

A date and time of the pattern M/d/yyyy h:mm:ss tt (see C Sharp System.DateTime)

updated_at?string

A date and time of the pattern M/d/yyyy h:mm:ss tt (see C Sharp System.DateTime)

id?string
namestring
Length1 <= length
description?string
Length1 <= length
tags?array<Tag>
imageUrlstring
Length1 <= length
thumbnailImageUrl?string
Length1 <= length
releaseStatus?string
Default"public"
Value in"public" | "private" | "hidden" | "all"
version?integer
Default1
Range0 <= value
unityPackageUrl?string
unityVersion?string
Default"5.3.4p1"
Length1 <= length

Response Body

application/json

application/json

application/json

curl -X POST "https://api.vrchat.cloud/api/1/avatars" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "imageUrl": "string"
  }'
{
  "acknowledgements": "string",
  "assetUrl": "string",
  "assetUrlObject": {},
  "authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "authorName": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "description": "string",
  "featured": false,
  "highestPrice": 0,
  "id": "avtr_912d66a4-4714-43b8-8407-7de2cafbf55b",
  "imageUrl": "string",
  "listingDate": "string",
  "lock": true,
  "lowestPrice": 0,
  "name": "string",
  "performance": {
    "android": "string",
    "android-sort": 0,
    "ios": "string",
    "ios-sort": 0,
    "standalonewindows": "string",
    "standalonewindows-sort": 0
  },
  "productId": "string",
  "publishedListings": [
    {
      "description": "string",
      "displayName": "string",
      "imageId": "string",
      "listingId": "string",
      "listingType": "string",
      "priceTokens": 0
    }
  ],
  "releaseStatus": "public",
  "searchable": false,
  "styles": {
    "primary": "string",
    "secondary": "string",
    "supplementary": [
      "string"
    ]
  },
  "tags": [
    "string"
  ],
  "thumbnailImageUrl": "string",
  "unityPackageUrl": "string",
  "unityPackageUrlObject": {
    "unityPackageUrl": "string"
  },
  "unityPackages": [
    {
      "id": "unp_52b12c39-4163-457d-a4a9-630e7aff1bff",
      "assetUrl": "https://api.vrchat.cloud/api/1/file/file_cd0caa7b-69ba-4715-8dfe-7d667a9d2537/65/file",
      "assetUrlObject": {},
      "assetVersion": 4,
      "created_at": "2020-09-10T06:13:27.777Z",
      "impostorizerVersion": "0.17.0",
      "performanceRating": "Excellent",
      "platform": "standalonewindows",
      "pluginUrl": "",
      "pluginUrlObject": {},
      "unitySortNumber": 20180414000,
      "unityVersion": "2022.3.6f1",
      "worldSignature": "AHiPAWerwCpeYrxDthF5TU2SdUWEWnm43UAn8PKRXlS8k8tVRQ==",
      "impostorUrl": "string",
      "scanStatus": "string",
      "variant": "string"
    }
  ],
  "updated_at": "2019-08-24T14:15:22Z",
  "version": 68
}

{
  "error": {
    "message": "You can't create an avatar right now",
    "status_code": 400
  }
}

{
  "error": {
    "message": "cannot set featured tag if you are not an admin",
    "status_code": 401
  }
}