Skip to content

AvatarsApi.md

Latest commit

 

History

History
463 lines (265 loc) · 14.4 KB

AvatarsApi.md

File metadata and controls

463 lines (265 loc) · 14.4 KB

\AvatarsApi

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

Method HTTP request Description
create_avatar POST /avatars Create Avatar
delete_avatar DELETE /avatars/{avatarId} Delete Avatar
delete_impostor DELETE /avatars/{avatarId}/impostor Delete generated Impostor
enqueue_impostor POST /avatars/{avatarId}/impostor/enqueue Enqueue Impostor generation
get_avatar GET /avatars/{avatarId} Get Avatar
get_avatar_styles GET /avatarStyles Get Avatar Styles
get_favorited_avatars GET /avatars/favorites List Favorited Avatars
get_impostor_queue_stats GET /avatars/impostor/queue/stats Get Impostor Queue Stats
get_licensed_avatars GET /avatars/licensed List Licensed Avatars
get_own_avatar GET /users/{userId}/avatar Get Own Avatar
search_avatars GET /avatars Search Avatars
select_avatar PUT /avatars/{avatarId}/select Select Avatar
select_fallback_avatar PUT /avatars/{avatarId}/selectFallback Select Fallback Avatar
update_avatar PUT /avatars/{avatarId} Update Avatar

create_avatar

models::Avatar create_avatar(create_avatar_request) 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 Required Notes
create_avatar_request Option<CreateAvatarRequest>

Return type

models::Avatar

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_avatar

models::Avatar delete_avatar(avatar_id) 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 Required Notes
avatar_id String Must be a valid avatar ID. [required]

Return type

models::Avatar

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_impostor

delete_impostor(avatar_id) Delete generated Impostor

Delete generated Impostor for that avatar.

Parameters

Name Type Description Required Notes
avatar_id String Must be a valid avatar ID. [required]

Return type

(empty response body)

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enqueue_impostor

models::ServiceStatus enqueue_impostor(avatar_id) Enqueue Impostor generation

Enqueue Impostor generation for that avatar.

Parameters

Name Type Description Required Notes
avatar_id String Must be a valid avatar ID. [required]

Return type

models::ServiceStatus

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_avatar

models::Avatar get_avatar(avatar_id) Get Avatar

Get information about a specific Avatar.

Parameters

Name Type Description Required Notes
avatar_id String Must be a valid avatar ID. [required]

Return type

models::Avatar

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_avatar_styles

Vecmodels::AvatarStyle get_avatar_styles() Get Avatar Styles

List avatar styles.

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::AvatarStyle

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_favorited_avatars

Vecmodels::Avatar get_favorited_avatars(featured, sort, n, order, offset, search, tag, notag, release_status, max_unity_version, min_unity_version, platform, user_id) List Favorited Avatars

Search and list favorited avatars by query filters.

Parameters

Name Type Description Required Notes
featured Option<bool> Filters on featured results.
sort Option<SortOption> The sort order of the results.
n Option<i32> The number of objects to return. [default to 60]
order Option<OrderOption> Result ordering
offset Option<i32> A zero-based offset from the default object sorting from where search results start.
search Option<String> Filters by world name.
tag Option<String> Tags to include (comma-separated). Any of the tags needs to be present.
notag Option<String> Tags to exclude (comma-separated).
release_status Option<ReleaseStatus> Filter by ReleaseStatus.
max_unity_version Option<String> The maximum Unity version supported by the asset.
min_unity_version Option<String> The minimum Unity version supported by the asset.
platform Option<String> The platform the asset supports.
user_id Option<String> Target user to see information on, admin-only.

Return type

Vecmodels::Avatar

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_impostor_queue_stats

models::ServiceQueueStats get_impostor_queue_stats() Get Impostor Queue Stats

Gets service stats for queued impostor.

Parameters

This endpoint does not need any parameter.

Return type

models::ServiceQueueStats

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_licensed_avatars

Vecmodels::Avatar get_licensed_avatars(n, offset) List Licensed Avatars

List licensed avatars.

Parameters

Name Type Description Required Notes
n Option<i32> The number of objects to return. [default to 60]
offset Option<i32> A zero-based offset from the default object sorting from where search results start.

Return type

Vecmodels::Avatar

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_own_avatar

models::Avatar get_own_avatar(user_id) 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 Required Notes
user_id String Must be a valid user ID. [required]

Return type

models::Avatar

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_avatars

Vecmodels::Avatar search_avatars(featured, sort, user, user_id, n, order, offset, tag, notag, release_status, max_unity_version, min_unity_version, platform, is_internal_variant) 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 Required Notes
featured Option<bool> Filters on featured results.
sort Option<SortOption> The sort order of the results.
user Option<String> Set to me for searching own avatars.
user_id Option<String> Filter by UserID.
n Option<i32> The number of objects to return. [default to 60]
order Option<OrderOption> Result ordering
offset Option<i32> A zero-based offset from the default object sorting from where search results start.
tag Option<String> Tags to include (comma-separated). Any of the tags needs to be present.
notag Option<String> Tags to exclude (comma-separated).
release_status Option<ReleaseStatus> Filter by ReleaseStatus.
max_unity_version Option<String> The maximum Unity version supported by the asset.
min_unity_version Option<String> The minimum Unity version supported by the asset.
platform Option<String> The platform the asset supports.
is_internal_variant Option<bool> Not quite sure what this actually does (exists on the website but doesn't seem to be used)

Return type

Vecmodels::Avatar

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

select_avatar

models::CurrentUser select_avatar(avatar_id) Select Avatar

Switches into that avatar.

Parameters

Name Type Description Required Notes
avatar_id String Must be a valid avatar ID. [required]

Return type

models::CurrentUser

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

select_fallback_avatar

models::CurrentUser select_fallback_avatar(avatar_id) Select Fallback Avatar

Switches into that avatar as your fallback avatar.

Parameters

Name Type Description Required Notes
avatar_id String Must be a valid avatar ID. [required]

Return type

models::CurrentUser

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_avatar

models::Avatar update_avatar(avatar_id, update_avatar_request) Update Avatar

Update information about a specific avatar.

Parameters

Name Type Description Required Notes
avatar_id String Must be a valid avatar ID. [required]
update_avatar_request Option<UpdateAvatarRequest>

Return type

models::Avatar

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]