8.6 KiB
\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 |
| get_avatar | GET /avatars/{avatarId} | Get Avatar |
| get_favorited_avatars | GET /avatars/favorites | List Favorited Avatars |
| search_avatars | GET /avatars | Search Avatars |
| select_avatar | PUT /avatars/{avatarId}/select | Select Avatar |
| update_avatar | PUT /avatars/{avatarId} | Update Avatar |
create_avatar
crate::models::Avatar create_avatar(inline_object10) 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 |
|---|---|---|---|---|
| inline_object10 | Option<InlineObject10> |
Return type
Authorization
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
crate::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 | [required] |
Return type
Authorization
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
crate::models::Avatar get_avatar(avatar_id) Get Avatar
Get information about a specific Avatar.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| avatar_id | String | [required] |
Return type
Authorization
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
Veccrate::models::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<String> | Filters on featured results. | ||
| sort | Option<String> | [default to popularity] | ||
| n | Option<i32> | The number of objects to return. | [default to 60] | |
| order | Option<String> | [default to descending] | ||
| 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). | ||
| notag | Option<String> | Tags to exclude (comma-separated). | ||
| release_status | Option<String> | Filter by ReleaseStatus. | [default to public] | |
| 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
Authorization
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
Veccrate::models::Avatar search_avatars(featured, sort, user, user_id, n, order, offset, tag, notag, release_status, max_unity_version, min_unity_version, platform) 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<String> | Filters on featured results. | ||
| sort | Option<String> | [default to popularity] | ||
| 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<String> | [default to descending] | ||
| 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). | ||
| notag | Option<String> | Tags to exclude (comma-separated). | ||
| release_status | Option<String> | Filter by ReleaseStatus. | [default to public] | |
| 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. |
Return type
Authorization
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
crate::models::CurrentUser select_avatar(avatar_id) Select Avatar
Switches into that avatar.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| avatar_id | String | [required] |
Return type
Authorization
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
crate::models::Avatar update_avatar(avatar_id, inline_object11) Update Avatar
Update information about a specific avatar.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| avatar_id | String | [required] | ||
| inline_object11 | Option<InlineObject11> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]