Get all assets of a schema

GET 
/assets/by/schema/:schemaId

Get all assets of a schema

Request

Path Parameters

schemaId schemaIdrequired

The schemaId to grab data about

Query Parameters

type assetType

The type of the assets to grab

matchTags boolean

Whether to get the assets that match the schema tags (coming from project and global assets)

Responses

200

List of assets for Schema

application/json

Schema

Schema

• Array [

name stringrequired

Asset name

url string

Asset URL

schemaId schemaId (string)

Unique identifier for Schema

type string
data string

Asset data

id string

Unique identifier for Asset

tags string[]

Asset tags

projectId projectId (string)

Unique identifier for Project

createdAt date-time

Time representation of Asset creation

description string

Asset description

• ]

Example (from schema)

[
  {
    "name": "How to Add a Border to an Image",
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "schemaId": "s2S7KuFGc",
    "type": "tutorial",
    "data": "{\"type\":\"youtube\",\"youtubeId\":\"e6pbkJ37U\"}",
    "id": "a7qDzJ7XD",
    "tags": [
      "adobeillustrator",
      "border",
      "imageborder"
    ],
    "projectId": "p2Duhf5N6",
    "createdAt": "2024-01-01T09:00:00.00Z",
    "description": "In today's video, I'll be showing you..."
  }
]

Example

[
  {
    "projectId": "null",
    "createdAt": "2024-01-07T15:00:00.00Z",
    "description": "A sleek 3D model of a cyberpunk motorcycle, perfect for high-speed chases",
    "id": "a14oCJX30",
    "tags": [
      "3D model",
      "motorcycle",
      "cyberpunk",
      "vehicle"
    ],
    "data": "{\"mesh\":{\"vertices\":[[-1.0,1.0,0.0],[1.0,1.0,0.0],[1.0,-1.0,0.0],[-1.0,-1.0,0.0]],\"base",
    "type": "vehicle",
    "url": "https://example.com/assets/cyberpunk-motorcycle.fbx",
    "schemaId": "s11EFBu2XW",
    "name": "Cyberpunk Motorcycle"
  },
  {
    "projectId": "null",
    "description": "A detailed 3D model of a futuristic cyberpunk cityscape",
    "createdAt": "2024-01-08T16:30:00.00Z",
    "id": "a1guhMEji",
    "tags": [
      "3D model",
      "city",
      "cyberpunk",
      "environment"
    ],
    "data": "{\"mesh\":{\"vertices\":[[-1.0,1.0,0.0],[1.0,1.0,0.0],[1.0,-1.0,0.0],[-1.0,-1.0,0.0]],\"vector",
    "type": "building",
    "url": "https://example.com/assets/cyberpunk-cityscape.fbx",
    "schemaId": "s11EFBu2XW",
    "name": "Cyberpunk Cityscape"
  }
]

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...