Assets

All surfaces, atlases, and 3D objects are Megascans assets. Find out more about the asset spec here.

Retrieving Assets

GET /v1/assets

Query Params

  • limit: The number of assets to return in the response. Used for pagination along with page.
  • page: Page number in the list of assets to return. Used for pagination along with limit.
  • type: One of “surface”, “atlas”, or “3d” to filter the type of assets returned. Omit to return assets of all types, in their default order.
  • tags: A comma separated 1 list of search tags
  • view: One of “myscans” or “favorited”. Omit to return all assets, in their default order.

Response

The response contains a collection of asset summaries, the paginated resource properties, and a list of search-able tags within the current collection of assets. tags are also filtered and reordered as you filter into the assets using either type or tags.

{
  "assets": [
    {
      "_id": "qirh02",
      "name": "qirh02",
      "tags": [
        "leaf",
        "green",
        "Philodendron bipinnatifidum",
        "selloum",
        "Spiny",
        "Lobed",
        "Pinnate"
      ],
      "categories": [
        "atlas",
        "plant",
        "perennials"
      ],
      "points": 1,
      "physicalSize": "0.91x0.91",
      "id": "qirh02",
      ...
    },
    ...
  ],
  "page": 1,
  "pages": 42,
  "total": 1417,
  "count": 24,
  "tags": [
    {
      "tag": "green",
      "weight": 994
    },
    {
      "tag": "leaf",
      "weight": 761
    },
    ...
  ]
}

Retrieving a Single Asset

GET /v1/assets/{id}

It is a recommended approach to only retrieve full asset details only when it’s needed for improved performance.

  1. The comma is URL-encoded and is represented with a %2C

Updated: