---
url: /apidocs/asset.md
---
## Asset bundle API

Asset API works with different versions of asset bundles. It recognises version from "assetVersion" parameter or "X-Asset-Version" header.

Currently API works with next asset versions:

1.0 - used by old client versions, deprecated

2.0 - used by client version 1.1.5+ and publisher version 2.0.0+

3.0 - reserved for Unity 2017.3

4.0 - reserved for Unity 2018.3 and higher

5.0 - version with skin support

6.0 - version with URP support

Commands that fetch assets also recognise "compatibleAssetVersions" parameter or "X-Compatible-Asset-Versions" header to fetch compatible asset version in case if main "assetVersion" not found.

| Endpoint | Method | Description |
|-----|-----|-----|
| [/api/v0/asset/listManagedNetworks](#list-asset-managed-networks) | webRequest | List asset managed networks |
| [/api/v0/asset/prop/create](#create-prop-asset) | webRequest | Create prop asset |
| [/api/v0/asset/style/create](#create-style-asset) | webRequest | Create style asset |
| [/api/v0/asset/environment/create](#create-environment-asset) | webRequest | Create environment asset |
| [/api/v0/asset/prop/update](#update-prop-asset) | webRequest | Update prop asset |
| [/api/v0/asset/style/update](#update-style-asset) | webRequest | Update style asset |
| [/api/v0/asset/environment/update](#update-environment-asset) | webRequest | Update environment asset |
| [/api/v0/asset/updateStatus](#update-asset-status) | webRequest | Update asset status |
| [/api/v0/asset/updateOwnership](#update-asset-ownership) | webRequest | Update asset ownership |
| [/api/v0/asset/prop/list](#list-prop-assets) | webRequest | List prop assets |
| [/api/v0/asset/style/list](#list-style-assets) | webRequest | List style assets |
| [/api/v0/asset/environment/list](#list-environment-assets) | webRequest | List environment assets |
| [/api/v0/asset/prop/listOwn](#list-user-own-prop-assets) | webRequest | List user own prop assets |
| [/api/v0/asset/style/listOwn](#list-user-own-style-assets) | webRequest | List user own style assets |
| [/api/v0/asset/environment/listOwn](#list-user-own-environment-assets) | webRequest | List user own environment assets |
| [/api/v0/asset/listPatchVersions](#list-patch-versions-for-asset-resources-and-their-creation-date-) | webRequest | List patch versions for asset resources and their creation date. |
| [/api/v0/asset/restorePatchVersion](#restore-asset-resources-from-the-patch-) | webRequest | Restore asset resources from the patch. |
| [/api/v0/asset/setOriginal](#set-asset-original-resource) | webRequest | Set asset original resource |
| [/api/v0/asset/remove](#remove-asset) | webRequest | Remove asset |
| [/api/v0/asset/metadata/{id}](#get-prop-asset-metadata) | webRequest | Get prop asset metadata |
| [/api/v0/asset/{assetId}/platform/{platform}](#get-asset-resource-data) | webRequest | Get asset resource data |
| [/{assetId}/platform/{platform}/patch/{patchVersion}](#get-asset-resource-data-per-patch-version) | webRequest | Get asset resource data per patch version |
| [/api/v0/asset/{assetId}](#get-asset-resource-data-for-default-platform) | webRequest | Get asset resource data for default platform |
| [/api/v0/asset/thumbnail/{id}](#get-asset-thumbnail-data) | webRequest | Get asset thumbnail data |
| [/api/v0/asset/original/{id}](#get-asset-original-data) | webRequest | Get asset original data |
| [/api/v0/asset/url/{assetId}/platform/{platform}](#get-asset-resource-url) | webRequest | Get asset resource url |
| [/api/v0/asset/url/{assetId}/platform/{platform}/patch/{patchVersion}](#get-asset-resource-url-per-patch-version) | webRequest | Get asset resource url per patch version |
| [/api/v0/asset/url/{assetId}](#get-asset-resource-url-for-default-platform) | webRequest | Get asset resource url for default platform |
| [/api/v0/asset/thumbnail/url/{id}](#get-asset-thumbnail-url) | webRequest | Get asset thumbnail url |
| [/api/v0/asset/original/url/{id}](#get-asset-original-url) | webRequest | Get asset original url |
| [/api/v0/asset/listSkinPatchVersions](#list-patch-versions-for-asset-resources-and-their-creation-date-) | webRequest | List patch versions for asset resources and their creation date. |
| [/api/v0/asset/restoreSkinPatchVersion](#restore-asset-resources-from-the-patch-) | webRequest | Restore asset resources from the patch. |
| [/api/v0/asset/upload/link](#direct-asset-upload-to-google-bucket-get-upload-link-) | webRequest | Direct asset upload to Google bucket (get upload link) |
| [/api/v0/asset/upload/link/complete](#direct-asset-upload-to-google-bucket-complete-upload-link-) | webRequest | Direct asset upload to Google bucket (complete upload link) |
| [/api/v0/asset/upload/thumbnail/link](#direct-asset-thumbnail-upload-to-google-bucket-get-upload-link-) | webRequest | Direct asset thumbnail upload to Google bucket (get upload link) |
| [/api/v0/asset/upload/thumbnail/link/complete](#direct-asset-thumbnail-upload-to-google-bucket-complete-upload-link-) | webRequest | Direct asset thumbnail upload to Google bucket (complete upload link) |
| [asset:updateAssetParams](#update-asset-params) | websocket | Update asset params |
| [asset:getPropAsset](#get-prop-asset) | websocket | Get prop asset |
| [asset:getStyleAsset](#get-style-asset) | websocket | Get style asset |
| [asset:getEnvironmentAsset](#get-environment-asset) | websocket | Get environment asset |
| [asset:searchProp](#search-prop-assets) | websocket | Search prop assets |
| [asset:searchStyle](#search-style-assets) | websocket | Search style assets |
| [asset:searchEnvironment](#search-environment-assets) | websocket | Search environment assets |
| [asset:listProps](#list-prop-assets-websocket-) | websocket | List prop assets (websocket) |
| [asset:listStyles](#list-style-assets-websocket-) | websocket | List style assets (websocket) |
| [asset:listEnvironments](#list-environment-assets-websocket-) | websocket | List environment assets (websocket) |

### List asset managed networks

**HTTP Method:** POST

**Path:** /api/v0/asset/listManagedNetworks

**Description:** Api returns list of networks where user have permissions to manage assets.

**Request:**

**Response:**

### Create prop asset

**HTTP Method:** POST

**Path:** /api/v0/asset/prop/create

**Request:**

**Response:**

### Create style asset

**HTTP Method:** POST

**Path:** /api/v0/asset/style/create

**Request:**

**Response:**

### Create environment asset

**HTTP Method:** POST

**Path:** /api/v0/asset/environment/create

**Request:**

**Response:**

### Update prop asset

**HTTP Method:** POST

**Path:** /api/v0/asset/prop/update

**Request:**

**Response:**

### Update style asset

**HTTP Method:** POST

**Path:** /api/v0/asset/style/update

**Request:**

**Response:**

### Update environment asset

**HTTP Method:** POST

**Path:** /api/v0/asset/environment/update

**Request:**

**Response:**

### Update asset status

**HTTP Method:** POST

**Path:** /api/v0/asset/updateStatus

**Request:**

**Response:**

### Update asset ownership

**HTTP Method:** POST

**Path:** /api/v0/asset/updateOwnership

**Request:**

**Response:**

### List prop assets

**HTTP Method:** POST

**Path:** /api/v0/asset/prop/list

**Request:**

**Response:**

### List style assets

**HTTP Method:** POST

**Path:** /api/v0/asset/style/list

**Request:**

**Response:**

### List environment assets

**HTTP Method:** POST

**Path:** /api/v0/asset/environment/list

**Request:**

**Response:**

### List user own prop assets

**HTTP Method:** POST

**Path:** /api/v0/asset/prop/listOwn

**Request:**

**Response:**

### List user own style assets

**HTTP Method:** POST

**Path:** /api/v0/asset/style/listOwn

**Request:**

**Response:**

### List user own environment assets

**HTTP Method:** POST

**Path:** /api/v0/asset/environment/listOwn

**Request:**

**Response:**

### List patch versions for asset resources and their creation date.

**HTTP Method:** POST

**Path:** /api/v0/asset/listPatchVersions

**Request:**

**Response:**

### Restore asset resources from the patch.

**HTTP Method:** POST

**Path:** /api/v0/asset/restorePatchVersion

**Request:**

**Response:**

### Set asset original resource

**HTTP Method:** POST

**Path:** /api/v0/asset/setOriginal

**Description:** API sets resource of original textures for asset.

**Request:**

**Response:**

### Remove asset

**HTTP Method:** POST

**Path:** /api/v0/asset/remove

**Request:**

**Response:**

### Get prop asset metadata

**HTTP Method:** POST

**Path:** /api/v0/asset/metadata/{id}

**Request:**

**Response:**

### Get asset resource data

**HTTP Method:** GET

**Path:** /api/v0/asset/{assetId}/platform/{platform}

**Request:**

**Response:**

### Get asset resource data per patch version

**HTTP Method:** GET

**Path:** /{assetId}/platform/{platform}/patch/{patchVersion}

**Request:**

**Response:**

### Get asset resource data for default platform

**HTTP Method:** GET

**Path:** /api/v0/asset/{assetId}

**Request:**

**Response:**

### Get asset thumbnail data

**HTTP Method:** GET

**Path:** /api/v0/asset/thumbnail/{id}

**Request:**

**Response:**

### Get asset original data

**HTTP Method:** GET

**Path:** /api/v0/asset/original/{id}

**Request:**

**Response:**

### Get asset resource url

**HTTP Method:** GET

**Path:** /api/v0/asset/url/{assetId}/platform/{platform}

**Request:**

**Response:**

### Get asset resource url per patch version

**HTTP Method:** GET

**Path:** /api/v0/asset/url/{assetId}/platform/{platform}/patch/{patchVersion}

**Request:**

**Response:**

### Get asset resource url for default platform

**HTTP Method:** GET

**Path:** /api/v0/asset/url/{assetId}

**Request:**

**Response:**

### Get asset thumbnail url

**HTTP Method:** GET

**Path:** /api/v0/asset/thumbnail/url/{id}

**Request:**

**Response:**

### Get asset original url

**HTTP Method:** GET

**Path:** /api/v0/asset/original/url/{id}

**Request:**

**Response:**

### List patch versions for asset resources and their creation date.

**HTTP Method:** POST

**Path:** /api/v0/asset/listSkinPatchVersions

**Request:**

**Response:**

### Restore asset resources from the patch.

**HTTP Method:** POST

**Path:** /api/v0/asset/restoreSkinPatchVersion

**Request:**

**Response:**

### Direct asset upload to Google bucket (get upload link)

**HTTP Method:** POST

**Path:** /api/v0/asset/upload/link

**Description:** Direct upload gives possibility to upload files directly from a client to a storage bucket. It consist of next steps:

1. Client asks the server for upload link. The server initializes an upload session and returns a link which could be used for upload.

2. Client [uploads a file to Google bucket](https://cloud.google.com/storage/docs/json_api/v1/how-tos/resumable-upload#upload-resumable).

3. Client [sends upload complete acknowledgment to the server](#direct-asset-upload-to-google-bucket-complete-upload-link).

**Request:**

**Response:**

### Direct asset upload to Google bucket (complete upload link)

**HTTP Method:** POST

**Path:** /api/v0/asset/upload/link/complete

**Description:** See [direct upload to Google bucket](#direct-asset-upload-to-google-bucket-get-upload-link).

**Request:**

**Response:**

### Direct asset thumbnail upload to Google bucket (get upload link)

**HTTP Method:** POST

**Path:** /api/v0/asset/upload/thumbnail/link

**Description:** The process is the same as [direct upload to Google bucket](#direct-asset-upload-to-google-bucket-get-upload-link). Complete with [thumbnail uploaded acknowledgment](#direct-asset-thumbnail-upload-to-google-bucket-complete-upload-link).

**Request:**

**Response:**

### Direct asset thumbnail upload to Google bucket (complete upload link)

**HTTP Method:** POST

**Path:** /api/v0/asset/upload/thumbnail/link/complete

**Description:** See [direct thumbnail upload to Google bucket](#direct-asset-thumbnail-upload-to-google-bucket-get-upload-link).

**Request:**

**Response:**

### Update asset params

**Method:** websocket

**Endpoint:** asset:updateAssetParams

**Request:**

**Response:**

### Get prop asset

**Method:** websocket

**Endpoint:** asset:getPropAsset

**Request:**

**Response:**

### Get style asset

**Method:** websocket

**Endpoint:** asset:getStyleAsset

**Request:**

**Response:**

### Get environment asset

**Method:** websocket

**Endpoint:** asset:getEnvironmentAsset

**Request:**

**Response:**

### Search prop assets

**Method:** websocket

**Endpoint:** asset:searchProp

**Request:**

**Response:**

### Search style assets

**Method:** websocket

**Endpoint:** asset:searchStyle

**Request:**

**Response:**

### Search environment assets

**Method:** websocket

**Endpoint:** asset:searchEnvironment

**Request:**

**Response:**

### List prop assets (websocket)

**Method:** websocket

**Endpoint:** asset:listProps

**Request:**

**Response:**

### List style assets (websocket)

**Method:** websocket

**Endpoint:** asset:listStyles

**Request:**

**Response:**

### List environment assets (websocket)

**Method:** websocket

**Endpoint:** asset:listEnvironments

**Request:**

**Response:**

## Models

#### Asset Bundle Prop

#### Resource

#### Resource Origin

#### Geolocation

#### Dimensions

#### Resource Data Audio

#### Resource Data Video

#### Resource Data Amazon

#### Resource Data Imdb

#### Resource Data Youtube

#### Resource Data Vimeo

#### Resource Data Pinterest

#### Resource Data Pixabay

#### Resource Data Facebook

#### Resource Data Remote Url

#### Live Stream Data

#### AI Generation Data

#### Resource Data Directory

#### Google Drive

#### Channel Data

#### Enrichment Data

#### Programmatic Action with children

#### Programmatic Action

#### XYZ

#### Asset Bundle Style

#### Asset Bundle Environment

#### Asset Bundle Skin

#### RGBA