dev.openplaylist.playlist

openplaylist.dev

Documentation

Record containing the playlist metadata.

main record

Record containing the playlist metadata.

Record Key tid Timestamp-based ID

Properties

collaborators array of string did Optional

Declared collaborators, informational only. The hosting app decides who may add items.

maxLength: 100 items
copiedFrom ref com.atproto.repo.strongRef Optional

The record this playlist was copied from, e.g. when an anonymous playlist is claimed into a signed-in user's repo.

cover blob Optional

Optional generated cover image for the playlist.

maxSize: 1.0 MB
createdAt string datetime Required

Client-declared timestamp when this playlist was created.

createdBy ref dev.openplaylist.defs#contributor Optional

Who created the playlist. For playlists hosted in the Open Playlist app repo this carries the anonymous creator's display name.

description string Optional

Optional free-text description.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
name string Required

Display name of the playlist.

maxLength: 640 bytesminLength: 1 bytesmaxGraphemes: 64 graphemes
theme string Optional

Presentation theme the creator chose. Readers that do not recognize a value render their default. Absent means cassette.

maxLength: 64 bytes
Known values: cassette, synthwave
View raw schema 
{
  "description": "Record containing the playlist metadata.",
  "key": "tid",
  "record": {
    "properties": {
      "collaborators": {
        "description": "Declared collaborators, informational only. The hosting app decides who may add items.",
        "items": {
          "format": "did",
          "type": "string"
        },
        "maxLength": 100,
        "type": "array"
      },
      "copiedFrom": {
        "description": "The record this playlist was copied from, e.g. when an anonymous playlist is claimed into a signed-in user's repo.",
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "cover": {
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "description": "Optional generated cover image for the playlist.",
        "maxSize": 1000000,
        "type": "blob"
      },
      "createdAt": {
        "description": "Client-declared timestamp when this playlist was created.",
        "format": "datetime",
        "type": "string"
      },
      "createdBy": {
        "description": "Who created the playlist. For playlists hosted in the Open Playlist app repo this carries the anonymous creator's display name.",
        "ref": "dev.openplaylist.defs#contributor",
        "type": "ref"
      },
      "description": {
        "description": "Optional free-text description.",
        "maxGraphemes": 300,
        "maxLength": 3000,
        "type": "string"
      },
      "mirrors": {
        "description": "Native service playlists that mirror this record.",
        "items": {
          "ref": "dev.openplaylist.defs#mirror",
          "type": "ref"
        },
        "maxLength": 10,
        "type": "array"
      },
      "name": {
        "description": "Display name of the playlist.",
        "maxGraphemes": 64,
        "maxLength": 640,
        "minLength": 1,
        "type": "string"
      },
      "theme": {
        "description": "Presentation theme the creator chose. Readers that do not recognize a value render their default. Absent means cassette.",
        "knownValues": [
          "cassette",
          "synthwave"
        ],
        "maxLength": 64,
        "type": "string"
      }
    },
    "required": [
      "name",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@