VRChatBackendDocs/Apis/AvatarsApi.md

AvatarsApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method	HTTP request	Description
createAvatar	POST /avatars	Create Avatar
deleteAvatar	DELETE /avatars/{avatarId}	Delete Avatar
deleteImpostor	DELETE /avatars/{avatarId}/impostor	Delete generated Impostor
enqueueImpostor	POST /avatars/{avatarId}/impostor/enqueue	Enqueue Impostor generation
getAvatar	GET /avatars/{avatarId}	Get Avatar
getAvatarStyles	GET /avatarStyles	Get Avatar Styles
getFavoritedAvatars	GET /avatars/favorites	List Favorited Avatars
getImpostorQueueStats	GET /avatars/impostor/queue/stats	Get Impostor Queue Stats
getLicensedAvatars	GET /avatars/licensed	List Licensed Avatars
getOwnAvatar	GET /users/{userId}/avatar	Get Own Avatar
searchAvatars	GET /avatars	Search Avatars
selectAvatar	PUT /avatars/{avatarId}/select	Select Avatar
selectFallbackAvatar	PUT /avatars/{avatarId}/selectFallback	Select Fallback Avatar
updateAvatar	PUT /avatars/{avatarId}	Update Avatar

createAvatar

Avatar createAvatar(CreateAvatarRequest)

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.

Parameters

Name	Type	Description	Notes
CreateAvatarRequest	CreateAvatarRequest		[optional]

Return type

Avatar

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteAvatar

Avatar deleteAvatar(avatarId)

Delete Avatar

Delete an avatar. Notice an avatar is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The AvatarID is permanently reserved.

Parameters

Name	Type	Description	Notes
avatarId	String	Must be a valid avatar ID.	[default to null]

Return type

Avatar

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteImpostor

deleteImpostor(avatarId)

Delete generated Impostor

Delete generated Impostor for that avatar.

Parameters

Name	Type	Description	Notes
avatarId	String	Must be a valid avatar ID.	[default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

enqueueImpostor

ServiceStatus enqueueImpostor(avatarId)

Enqueue Impostor generation

Enqueue Impostor generation for that avatar.

Parameters

Name	Type	Description	Notes
avatarId	String	Must be a valid avatar ID.	[default to null]

Return type

ServiceStatus

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getAvatar

Avatar getAvatar(avatarId)

Get Avatar

Get information about a specific Avatar.

Parameters

Name	Type	Description	Notes
avatarId	String	Must be a valid avatar ID.	[default to null]

Return type

Avatar

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getAvatarStyles

List getAvatarStyles()

Get Avatar Styles

List avatar styles.

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getFavoritedAvatars

List getFavoritedAvatars(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId)

List Favorited Avatars

Search and list favorited avatars by query filters.

Parameters

Name	Type	Description	Notes
featured	Boolean	Filters on featured results.	[optional] [default to null]
sort	String	The sort order of the results.	[optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated]
n	Integer	The number of objects to return.	[optional] [default to 60]
order	String	Result ordering	[optional] [default to descending] [enum: ascending, descending]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]
search	String	Filters by world name.	[optional] [default to null]
tag	String	Tags to include (comma-separated). Any of the tags needs to be present.	[optional] [default to null]
notag	String	Tags to exclude (comma-separated).	[optional] [default to null]
releaseStatus	String	Filter by ReleaseStatus.	[optional] [default to public] [enum: all, hidden, private, public]
maxUnityVersion	String	The maximum Unity version supported by the asset.	[optional] [default to null]
minUnityVersion	String	The minimum Unity version supported by the asset.	[optional] [default to null]
platform	String	The platform the asset supports.	[optional] [default to null]
userId	String	Target user to see information on, admin-only.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getImpostorQueueStats

ServiceQueueStats getImpostorQueueStats()

Get Impostor Queue Stats

Gets service stats for queued impostor.

Parameters

This endpoint does not need any parameter.

Return type

ServiceQueueStats

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getLicensedAvatars

List getLicensedAvatars(n, offset)

List Licensed Avatars

List licensed avatars.

Parameters

Name	Type	Description	Notes
n	Integer	The number of objects to return.	[optional] [default to 60]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getOwnAvatar

Avatar getOwnAvatar(userId)

Get Own Avatar

Get the current avatar for the user. This will return an error for any other user than the one logged in.

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]

Return type

Avatar

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

searchAvatars

List searchAvatars(featured, sort, user, userId, n, order, offset, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, isInternalVariant)

Search Avatars

Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.

Parameters

Name	Type	Description	Notes
featured	Boolean	Filters on featured results.	[optional] [default to null]
sort	String	The sort order of the results.	[optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated]
user	String	Set to `me` for searching own avatars.	[optional] [default to null] [enum: me]
userId	String	Filter by UserID.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
order	String	Result ordering	[optional] [default to descending] [enum: ascending, descending]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]
tag	String	Tags to include (comma-separated). Any of the tags needs to be present.	[optional] [default to null]
notag	String	Tags to exclude (comma-separated).	[optional] [default to null]
releaseStatus	String	Filter by ReleaseStatus.	[optional] [default to public] [enum: all, hidden, private, public]
maxUnityVersion	String	The maximum Unity version supported by the asset.	[optional] [default to null]
minUnityVersion	String	The minimum Unity version supported by the asset.	[optional] [default to null]
platform	String	The platform the asset supports.	[optional] [default to null]
isInternalVariant	Boolean	Not quite sure what this actually does (exists on the website but doesn't seem to be used)	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

selectAvatar

CurrentUser selectAvatar(avatarId)

Select Avatar

Switches into that avatar.

Parameters

Name	Type	Description	Notes
avatarId	String	Must be a valid avatar ID.	[default to null]

Return type

CurrentUser

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

selectFallbackAvatar

CurrentUser selectFallbackAvatar(avatarId)

Select Fallback Avatar

Switches into that avatar as your fallback avatar.

Parameters

Name	Type	Description	Notes
avatarId	String	Must be a valid avatar ID.	[default to null]

Return type

CurrentUser

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

updateAvatar

Avatar updateAvatar(avatarId, UpdateAvatarRequest)

Update Avatar

Update information about a specific avatar.

Parameters

Name	Type	Description	Notes
avatarId	String	Must be a valid avatar ID.	[default to null]
UpdateAvatarRequest	UpdateAvatarRequest		[optional]

Return type

Avatar

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json