Raw schema
{
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"slipcover",
"side-load-vhs",
"doublevhs",
"betamax",
"bluray-cover",
"bluray-slipcover",
"dvd-cover",
"clamshell",
"polycase",
"cardbox",
"disc",
"cassette",
"cassingle",
"jcard",
"cd",
"cd-tray",
"cd-insert",
"vinyl-label",
"vinyl-jacket",
"vinyl-sleeve",
"minidisc-label",
"minidisc-cover",
"minidisc-jcard",
"minidisc-tray",
"minidisc-full-labels"
],
"description": "Which packaging format"
},
"content": {
"type": "object",
"description": "What the design is of. Provide a query, or an id from search_content. Video formats take movie/tv; audio formats (cassette, jcard, cd*, vinyl*, minidisc*) take album. For audio, the album alone builds the complete design — cover art, tracklist sides, QR code.",
"properties": {
"type": {
"type": "string",
"enum": [
"movie",
"tv",
"album"
]
},
"query": {
"type": "string"
},
"id": {
"type": "string",
"description": "TMDB id (movie/tv) or iTunes collection id (album), if already known"
}
},
"required": [
"type"
],
"additionalProperties": false
},
"text": {
"type": "object",
"description": "Overrides for the fetched metadata (video formats only — on audio formats these come back as unsupported). Omit a field to keep the provider value.",
"properties": {
"title": {
"type": "string"
},
"tagline": {
"type": "string"
},
"overview": {
"type": "string"
},
"year": {
"type": "string"
},
"runtime": {
"type": "string"
},
"rating": {
"type": "string"
},
"starring": {
"type": "string"
},
"director": {
"type": "string"
},
"writers": {
"type": "string"
},
"composer": {
"type": "string"
},
"producer": {
"type": "string"
},
"budget": {
"type": "string"
},
"revenue": {
"type": "string"
},
"seasonEpisode": {
"type": "string"
},
"origin": {
"type": "string"
},
"texsOrg": {
"type": "string"
}
},
"additionalProperties": false
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"description": "Font family. Curated: Futura, Arial, Times New Roman, Impact, Courier New, Roboto Flex, Bebas Neue, League Gothic, Sofia Sans Extra Condensed, Nunito Sans, Stint Ultra Condensed, EB Garamond…"
},
"labelColor": {
"type": "string",
"description": "6-digit hex, e.g. #e8dcc0"
},
"background": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "6-digit hex"
}
},
"additionalProperties": false
},
"useLogo": {
"type": "boolean",
"description": "true paints the provider's logo artwork for the title; false renders your title as text. Defaults to false when you set text.title, so a title you set is visible."
},
"finish": {
"type": "string",
"enum": [
"worn",
"clean",
"plain"
],
"description": "'worn' (default) fills the back panel with the title's stills and adds a worn-paper texture; 'clean' is stills without the texture; 'plain' skips both."
}
},
"additionalProperties": false
},
"layout": {
"type": "object",
"properties": {
"hide": {
"type": "array",
"items": {
"type": "string",
"enum": [
"rating",
"texsOrg",
"overview",
"labelOverview",
"fbiWarning",
"rules",
"pullquote",
"pullquoteCredit",
"spineMeta",
"barcode",
"qrCode",
"spineLogo",
"title",
"tagline",
"year",
"origin",
"runtime",
"starring",
"director",
"budget",
"revenue",
"movieId",
"seasonEpisode",
"writers",
"composer",
"producer",
"productionLogos"
]
},
"description": "Fields to hide on the design"
}
},
"additionalProperties": false
}
},
"required": [
"format"
],
"additionalProperties": false
}