fm.freemix.collection.crate Documentation (EN)

main record

A crate (playlist/collection) of tracks

Record Key tid Timestamp-based ID

Properties

coverImageUrl string uri Optional

URL to crate cover image

maxLength: 3000 bytes

createdAt string datetime Required

Record creation timestamp

maxLength: 100 bytes

description string Optional

Crate description

maxLength: 2000 bytes

isPublic boolean Optional

Whether the crate is publicly visible

Default: true

name string Required

Crate name

maxLength: 200 bytes

tracks array of string at-uri Optional

Ordered list of track AT URIs

maxLength: 500 items

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "createdAt"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 200,
        "description": "Crate name"
      },
      "tracks": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri",
          "maxLength": 3000
        },
        "maxLength": 500,
        "description": "Ordered list of track AT URIs"
      },
      "isPublic": {
        "type": "boolean",
        "default": true,
        "description": "Whether the crate is publicly visible"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "maxLength": 100,
        "description": "Record creation timestamp"
      },
      "description": {
        "type": "string",
        "maxLength": 2000,
        "description": "Crate description"
      },
      "coverImageUrl": {
        "type": "string",
        "format": "uri",
        "maxLength": 3000,
        "description": "URL to crate cover image"
      }
    }
  },
  "description": "A crate (playlist/collection) of tracks"
}