Card Content Schema

This is an example of the properties that can be set when creating a playlist.

{
  "cardId": "A1B2C",
  "title": "My Sample Card",
  "availability": "free",
  "metadata": {
    "accent": "British",
    "addToFamilyLibrary": true,
    "author": "Jane Doe",
    "category": "stories", // 'none', 'stories', 'music', 'radio', 'podcast', 'sfx', 'activities', 'alarms'
    "copyright": "© 2025 My Company",
    "cover": {
      "imageL": "https://example.com/image.jpg"
    },
    "description": "A delightful story for children.",
    "genre": ["Adventure", "Fantasy"],
    "hidden": false,
    "languages": ["en", "fr"], // 'en', 'en-gb', 'en-us', 'fr', 'fr-fr', 'es', 'es-es', 'es-419', 'de', 'it'
    "maxAge": 12,
    "media": {
      "duration": 3600,
      "fileSize": 10485760,
      "hasStreams": true
    },
    "minAge": 5,
    "musicType": ["Classical", "Instrumental"],
    "note": "For ages 5 to 12",
    "order": "featured",
    "audioPreviewUrl": "https://example.com/preview.mp3",
    "readBy": "Narrator Name",
    "share": true,
    "status": {
      "name": "new", // 'new', 'inprogress', 'complete', 'live', 'archived'
      "updatedAt": "2025-05-28T12:00:00Z"
    },
    "tags": ["audio", "story", "kids"],
    "feedUrl": "https://podcast.example.com/feed.xml",
    "numEpisodes": 25,
    "playbackDirection": "DESC" // 'DESC', 'ASC'
  },
  "content": {
    "activity": "yoto_Player",
    "chapters": [
      {
        "key": "ch1",
        "title": "Chapter One",
        "duration": 600,
        "tracks": [
          {
            "key": "track1",
            "trackUrl": "https://example.com/audio.mp3",
            "type": "audio", // 'audio', 'stream'
            "format": "mp3", // 'mp3', 'aac', 'alac', 'flac', 'pcm_s16le', 'opus', 'ogg', 'x', 'wav', 'aiff', 'mpeg'
            "duration": 600
          }
        ]
      }
    ],
    "config": {
      "autoadvance": "true",
      "resumeTimeout": 300,
      "systemActivity": true,
      "trackNumberOverlayTimeout": 5
    },
    "editSettings": {
      "autoOverlayLabels": "chapter-labels",
      "editKeys": false,
      "interactiveContent": false,
      "podcastTrackDisplay": {
        "icon16x16": "https://example.com/icon.png"
      },
      "podcastType": "rss-podcast",
      "transcodeAudioUploads": true // necessary for streaming cards
    },
    "playbackType": "linear", // 'linear', 'interactive'
    "restricted": false,
    "settings": {
      "autoplay": "true"
    },
    "version": "1.0.0"
  },
  "tags": ["education", "fun"],
  "slug": "my-sample-card"
}