catalog.marketing.templates.list
The marketing designs
GET/catalog/marketing/templates
The marketing video designs this deployment can make, by family. walkthrough designs cut a recorded walkthrough into a promo; website designs build one from a scanned site and need no recording. Each entry carries its formats, its lengths, its audio modes, its copy roles and what an export of it costs in seconds.
curl 'https://api.gogoscreen.com/api/v1/catalog/marketing/templates' \
-H "Authorization: Bearer $GOGOSCREEN_API_KEY"{
"family": "walkthrough",
"templates": [
{
"schemaVersion": 1,
"id": "marketing:pulse-launch",
"name": "Pulse Launch",
"description": "A headline lands over the product, one real action shows its result, the brand closes.",
"version": "1.2.0",
"compositionVersion": "1.0.0",
"formats": [
"landscape"
],
"audioModes": [
"music"
],
"musicCollection": "modern-electronic",
"intensityOptions": [
"polished"
],
"destinations": {
"landscape": [
{
"id": "generic",
"version": "1.0.0",
"name": "Anywhere",
"summary": "The margin these templates are drawn to."
}
],
"portrait": [
{
"id": "generic",
"version": "1.0.0",
"name": "Anywhere",
"summary": "The margin these templates are drawn to."
}
],
"square": [
{
"id": "generic",
"version": "1.0.0",
"name": "Anywhere",
"summary": "The margin these templates are drawn to."
}
],
"four-five": [
{
"id": "generic",
"version": "1.0.0",
"name": "Anywhere",
"summary": "The margin these templates are drawn to."
}
]
},
"slots": [
{
"id": "hook",
"kind": "product-preview",
"required": true,
"proofMs": 2500
}
],
"textLimits": {
"headline": {
"maxChars": 40,
"maxLines": {
"landscape": 1,
"portrait": 2,
"square": 2,
"four-five": 2
}
},
"subline": {
"maxChars": 70,
"maxLines": {
"landscape": 1,
"portrait": 2,
"square": 2,
"four-five": 2
},
"optional": true
},
"cta": {
"maxChars": 32,
"maxLines": {
"landscape": 1,
"portrait": 2,
"square": 2,
"four-five": 2
}
},
"panels": {
"maxChars": 24,
"maxLines": {
"landscape": 1,
"portrait": 1,
"square": 1,
"four-five": 1
},
"list": true,
"minItems": 2,
"maxItems": 3,
"optional": true,
"itemNoun": "panel"
}
},
"copyRoles": {
"headline": "headline",
"subline": "supporting-line",
"cta": "cta",
"panels": "panel-labels"
},
"arrangements": {
"15": {
"templateId": "marketing:pulse-launch",
"templateVersion": "1.2.0",
"seconds": 15,
"intensity": null,
"fps": {
"num": 30,
"den": 1
},
"totalFrames": 450,
"slots": [
{
"id": "hook",
"kind": "product-preview",
"required": true,
"frames": [
0
],
"proofFrames": 75,
"transitionIn": null
}
],
"holdBudget": {
"close": 33,
"hook": 30
}
},
"20": {
"templateId": "marketing:pulse-launch",
"templateVersion": "1.2.0",
"seconds": 20,
"intensity": null,
"fps": {
"num": 30,
"den": 1
},
"totalFrames": 600,
"slots": [
{
"id": "hook",
"kind": "product-preview",
"required": true,
"frames": [
0
],
"proofFrames": 75,
"transitionIn": null
}
],
"holdBudget": {
"close": 60,
"hook": 30
}
},
"30": {
"templateId": "marketing:pulse-launch",
"templateVersion": "1.2.0",
"seconds": 30,
"intensity": null,
"fps": {
"num": 30,
"den": 1
},
"totalFrames": 900,
"slots": [
{
"id": "hook",
"kind": "product-preview",
"required": true,
"frames": [
0
],
"proofFrames": 75,
"transitionIn": null
}
],
"holdBudget": {
"close": 60,
"hook": 30
}
}
},
"layout": {
"landscape": {
"canvas": {
"width": 1920,
"height": 1080
},
"slots": {
"hook": {
"box": {
"top": 0.42,
"height": 0.6,
"marginX": 200
},
"zoom": 1
},
"demonstration": {
"box": {
"top": 0.05,
"height": 0.9,
"marginX": 100
},
"zoom": 1.25
},
"benefit": {
"box": {
"top": 0.12,
"height": 0.76,
"marginX": 160
},
"zoom": 1.15
},
"panels": {
"box": {
"top": 0.16,
"height": 0.58,
"marginX": 140
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "row",
"gap": 32,
"labelPx": 34,
"labelPad": 12,
"labelLineHeight": 1.2
}
}
},
"text": {
"headline": {
"px": 104
},
"subline": {
"px": 40
},
"cta": {
"px": 96
},
"brand": {
"px": 30,
"pad": {
"x": 48,
"y": 36
}
},
"inset": {
"x": 160,
"y": 40
},
"caption": {
"px": 46,
"lines": 2,
"pad": 16,
"lineHeight": 1.25
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 140,
"top": 173,
"width": 804,
"height": 561
},
"label": {
"left": 140,
"top": 734,
"width": 804,
"height": 65
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 140,
"top": 173,
"width": 525,
"height": 561
},
"label": {
"left": 140,
"top": 734,
"width": 525,
"height": 65
}
}
]
},
"captioned": {
"slots": {
"hook": {
"box": {
"top": 0.42,
"height": 0.39166666666666666,
"marginX": 200
},
"zoom": 1
},
"demonstration": {
"box": {
"top": 0.05,
"height": 0.7620370370370371,
"marginX": 100
},
"zoom": 1.25
},
"benefit": {
"box": {
"top": 0.12,
"height": 0.6916666666666667,
"marginX": 160
},
"zoom": 1.15
},
"panels": {
"box": {
"top": 0.16,
"height": 0.58,
"marginX": 140
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "row",
"gap": 32,
"labelPx": 34,
"labelPad": 12,
"labelLineHeight": 1.2
}
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 140,
"top": 173,
"width": 804,
"height": 561
},
"label": {
"left": 140,
"top": 734,
"width": 804,
"height": 65
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 140,
"top": 173,
"width": 525,
"height": 561
},
"label": {
"left": 140,
"top": 734,
"width": 525,
"height": 65
}
}
]
}
},
"destinations": {}
},
"portrait": {
"canvas": {
"width": 1080,
"height": 1920
},
"slots": {
"hook": {
"box": {
"top": 0.3,
"height": 0.36,
"marginX": 36
},
"zoom": 1,
"frame": "fit"
},
"demonstration": {
"box": {
"top": 0.1,
"height": 0.62,
"marginX": 36
},
"zoom": 1.6,
"frame": "fill"
},
"benefit": {
"box": {
"top": 0.12,
"height": 0.58,
"marginX": 36
},
"zoom": 1.4,
"frame": "fill"
},
"panels": {
"box": {
"top": 0.16,
"height": 0.62,
"marginX": 60
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "column",
"gap": 28,
"labelPx": 40,
"labelPad": 12,
"labelLineHeight": 1.2
}
}
},
"text": {
"headline": {
"px": 88
},
"subline": {
"px": 40
},
"cta": {
"px": 84
},
"brand": {
"px": 30,
"pad": {
"x": 36,
"y": 36
}
},
"inset": {
"x": 70,
"y": 60
},
"caption": {
"px": 50,
"lines": 2,
"pad": 16,
"lineHeight": 1.25
}
},
"destinations": {
"portrait-social": {
"slots": {
"hook": {
"box": {
"top": 0.32,
"height": 0.3,
"marginX": 36
},
"zoom": 1,
"frame": "fit"
},
"demonstration": {
"box": {
"top": 0.17,
"height": 0.6,
"marginX": 36
},
"zoom": 1.6,
"frame": "fill"
},
"benefit": {
"box": {
"top": 0.18,
"height": 0.57,
"marginX": 36
},
"zoom": 1.4,
"frame": "fill"
},
"panels": {
"box": {
"top": 0.16,
"height": 0.62,
"marginX": 60
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "column",
"gap": 28,
"labelPx": 40,
"labelPad": 12,
"labelLineHeight": 1.2
}
}
},
"text": {
"headline": {
"px": 88
},
"subline": {
"px": 40
},
"cta": {
"px": 84
},
"brand": {
"px": 30,
"pad": {
"x": 70,
"y": 400
}
},
"inset": {
"x": 70,
"y": 300,
"bottom": 400
},
"caption": {
"px": 50,
"lines": 2,
"pad": 16,
"lineHeight": 1.25
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 60,
"top": 307,
"width": 960,
"height": 509
},
"label": {
"left": 60,
"top": 816,
"width": 960,
"height": 72
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 60,
"top": 307,
"width": 960,
"height": 306
},
"label": {
"left": 60,
"top": 613,
"width": 960,
"height": 72
}
}
]
},
"captioned": {
"slots": {
"hook": {
"box": {
"top": 0.32,
"height": 0.3,
"marginX": 36
},
"zoom": 1,
"frame": "fit"
},
"demonstration": {
"box": {
"top": 0.17,
"height": 0.5317708333333333,
"marginX": 36
},
"zoom": 1.6,
"frame": "fill"
},
"benefit": {
"box": {
"top": 0.18,
"height": 0.5213541666666667,
"marginX": 36
},
"zoom": 1.4,
"frame": "fill"
},
"panels": {
"box": {
"top": 0.16,
"height": 0.5416666666666666,
"marginX": 60
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "column",
"gap": 28,
"labelPx": 40,
"labelPad": 12,
"labelLineHeight": 1.2
}
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 60,
"top": 307,
"width": 960,
"height": 434
},
"label": {
"left": 60,
"top": 741,
"width": 960,
"height": 72
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 60,
"top": 307,
"width": 960,
"height": 256
},
"label": {
"left": 60,
"top": 563,
"width": 960,
"height": 72
}
}
]
}
}
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 60,
"top": 307,
"width": 960,
"height": 509
},
"label": {
"left": 60,
"top": 816,
"width": 960,
"height": 72
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 60,
"top": 307,
"width": 960,
"height": 306
},
"label": {
"left": 60,
"top": 613,
"width": 960,
"height": 72
}
}
]
},
"captioned": {
"slots": {
"hook": {
"box": {
"top": 0.3,
"height": 0.36,
"marginX": 36
},
"zoom": 1,
"frame": "fit"
},
"demonstration": {
"box": {
"top": 0.1,
"height": 0.62,
"marginX": 36
},
"zoom": 1.6,
"frame": "fill"
},
"benefit": {
"box": {
"top": 0.12,
"height": 0.58,
"marginX": 36
},
"zoom": 1.4,
"frame": "fill"
},
"panels": {
"box": {
"top": 0.16,
"height": 0.62,
"marginX": 60
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "column",
"gap": 28,
"labelPx": 40,
"labelPad": 12,
"labelLineHeight": 1.2
}
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 60,
"top": 307,
"width": 960,
"height": 509
},
"label": {
"left": 60,
"top": 816,
"width": 960,
"height": 72
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 60,
"top": 307,
"width": 960,
"height": 306
},
"label": {
"left": 60,
"top": 613,
"width": 960,
"height": 72
}
}
]
}
}
},
"square": {
"canvas": {
"width": 1080,
"height": 1080
},
"slots": {
"hook": {
"box": {
"top": 0.4,
"height": 0.46,
"marginX": 80
},
"zoom": 1,
"frame": "fit"
},
"demonstration": {
"box": {
"top": 0.1,
"height": 0.78,
"marginX": 56
},
"zoom": 1.35,
"frame": "fill"
},
"benefit": {
"box": {
"top": 0.14,
"height": 0.7,
"marginX": 80
},
"zoom": 1.25,
"frame": "fill"
},
"panels": {
"box": {
"top": 0.22,
"height": 0.5,
"marginX": 44
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "row",
"gap": 20,
"labelPx": 28,
"labelPad": 10,
"labelLineHeight": 1.2
}
}
},
"text": {
"headline": {
"px": 72
},
"subline": {
"px": 34
},
"cta": {
"px": 68
},
"brand": {
"px": 28,
"pad": {
"x": 44,
"y": 36
}
},
"inset": {
"x": 72,
"y": 40
},
"caption": {
"px": 42,
"lines": 2,
"pad": 14,
"lineHeight": 1.25
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 44,
"top": 238,
"width": 486,
"height": 486
},
"label": {
"left": 44,
"top": 724,
"width": 486,
"height": 54
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 44,
"top": 238,
"width": 317,
"height": 486
},
"label": {
"left": 44,
"top": 724,
"width": 317,
"height": 54
}
}
]
},
"captioned": {
"slots": {
"hook": {
"box": {
"top": 0.4,
"height": 0.425,
"marginX": 80
},
"zoom": 1,
"frame": "fit"
},
"demonstration": {
"box": {
"top": 0.1,
"height": 0.725,
"marginX": 56
},
"zoom": 1.35,
"frame": "fill"
},
"benefit": {
"box": {
"top": 0.14,
"height": 0.6851851851851852,
"marginX": 80
},
"zoom": 1.25,
"frame": "fill"
},
"panels": {
"box": {
"top": 0.22,
"height": 0.5,
"marginX": 44
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "row",
"gap": 20,
"labelPx": 28,
"labelPad": 10,
"labelLineHeight": 1.2
}
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 44,
"top": 238,
"width": 486,
"height": 486
},
"label": {
"left": 44,
"top": 724,
"width": 486,
"height": 54
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 44,
"top": 238,
"width": 317,
"height": 486
},
"label": {
"left": 44,
"top": 724,
"width": 317,
"height": 54
}
}
]
}
},
"destinations": {}
},
"four-five": {
"canvas": {
"width": 1080,
"height": 1350
},
"slots": {
"hook": {
"box": {
"top": 0.34,
"height": 0.42,
"marginX": 44
},
"zoom": 1,
"frame": "fit"
},
"demonstration": {
"box": {
"top": 0.11,
"height": 0.7,
"marginX": 40
},
"zoom": 1.5,
"frame": "fill"
},
"benefit": {
"box": {
"top": 0.14,
"height": 0.64,
"marginX": 40
},
"zoom": 1.35,
"frame": "fill"
},
"panels": {
"box": {
"top": 0.13,
"height": 0.7,
"marginX": 48
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "column",
"gap": 20,
"labelPx": 30,
"labelPad": 11,
"labelLineHeight": 1.2
}
}
},
"text": {
"headline": {
"px": 76
},
"subline": {
"px": 36
},
"cta": {
"px": 72
},
"brand": {
"px": 28,
"pad": {
"x": 40,
"y": 36
}
},
"inset": {
"x": 68,
"y": 48
},
"caption": {
"px": 44,
"lines": 2,
"pad": 14,
"lineHeight": 1.25
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 48,
"top": 176,
"width": 984,
"height": 405
},
"label": {
"left": 48,
"top": 581,
"width": 984,
"height": 58
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 48,
"top": 176,
"width": 984,
"height": 244
},
"label": {
"left": 48,
"top": 420,
"width": 984,
"height": 58
}
}
]
},
"captioned": {
"slots": {
"hook": {
"box": {
"top": 0.34,
"height": 0.42,
"marginX": 44
},
"zoom": 1,
"frame": "fit"
},
"demonstration": {
"box": {
"top": 0.11,
"height": 0.7,
"marginX": 40
},
"zoom": 1.5,
"frame": "fill"
},
"benefit": {
"box": {
"top": 0.14,
"height": 0.64,
"marginX": 40
},
"zoom": 1.35,
"frame": "fill"
},
"panels": {
"box": {
"top": 0.13,
"height": 0.7,
"marginX": 48
},
"zoom": 1,
"frame": "fill",
"grid": {
"direction": "column",
"gap": 20,
"labelPx": 30,
"labelPad": 11,
"labelLineHeight": 1.2
}
}
},
"panelCells": {
"2": [
{
"index": 0,
"card": {
"left": 48,
"top": 176,
"width": 984,
"height": 405
},
"label": {
"left": 48,
"top": 581,
"width": 984,
"height": 58
}
}
],
"3": [
{
"index": 0,
"card": {
"left": 48,
"top": 176,
"width": 984,
"height": 244
},
"label": {
"left": 48,
"top": 420,
"width": 984,
"height": 58
}
}
]
}
},
"destinations": {}
}
},
"panels": {
"refs": [
"panelA"
],
"min": 2,
"max": 3
},
"holds": {
"maxFrames": 90,
"slots": [
"demonstration"
]
},
"holdGivers": {
"close": {
"gives": 60,
"keeps": 45
},
"hook": {
"gives": 30,
"keeps": 90
}
},
"motion": {
"polished": {
"overlapFrames": 18,
"headline": {
"damping": 18,
"stiffness": 100,
"staggerFrames": 3
},
"bedFadeOutFrames": 60,
"field": {
"periodFrames": 420,
"opacity": 0.18
}
},
"bold": {
"overlapFrames": 15,
"headline": {
"damping": 14,
"stiffness": 120,
"staggerFrames": 2
},
"bedFadeOutFrames": 45,
"field": {
"periodFrames": 300,
"opacity": 0.24
}
},
"energetic": {
"overlapFrames": 10,
"headline": {
"damping": 11,
"stiffness": 170,
"staggerFrames": 1
},
"bedFadeOutFrames": 30,
"field": {
"periodFrames": 180,
"opacity": 0.3
}
}
},
"brandField": {
"slots": [
"hook"
],
"colours": [
"accent"
],
"blobs": 3,
"diameter": 0.9,
"travel": 0.12
},
"defaultTrackId": "make-it-happen",
"secondsPerExport": {
"landscape": {
"15": 15,
"20": 20,
"30": 30
},
"portrait": {
"15": 15,
"20": 20,
"30": 30
},
"square": {
"15": 15,
"20": 20,
"30": 30
},
"four-five": {
"15": 15,
"20": 20,
"30": 30
}
}
}
],
"tracks": [
{
"id": "make-it-happen",
"title": "Make It Happen",
"mood": "polished",
"collection": "modern-electronic",
"testingOnly": false,
"attribution": "Music: Make It Happen by 1000 Handz, CC BY 4.0, from the Free Music Archive",
"hasEnding": true
}
]
}At a glance
| Fact | Detail |
|---|---|
| Scopes | catalog:read |
| Credentials | a signed in dashboard session or an API key. |
| Rate limit | 600 requests a minute per credential, in the read class. |
| Idempotency | Not applicable. This operation changes nothing. |
| MCP tool | catalog_marketing_templates_list |
| Always sets | Cache-Control: public, max-age=300 |
200 OK
The marketing designs
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| family | string | one of: walkthrough, website | ||||||||||||||||||||||||
| narration | object | null | What a narrated design may be asked for: cadences, speed range and languages. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys | ||||||||||||||||||||||||
| templates | object[] | |||||||||||||||||||||||||
7 fields inside templates
| ||||||||||||||||||||||||||
| tracks | object[] | |||||||||||||||||||||||||
| collection | string | |||||||||||||||||||||||||
| id | string | |||||||||||||||||||||||||
| mood | string | |||||||||||||||||||||||||
| title | string | |||||||||||||||||||||||||
| Header | Meaning |
|---|---|
Cache-Control | Always public, max-age=300. |
Errors
Every refusal is { error: { code, message, details?, requestId } }. Branch on code, never on the sentence. The full catalogue is at Errors.
| Code | Status | When it happens | What to do |
|---|---|---|---|
| validation_failed | 400 | The merged path, query and body did not match the operation's schema. The schemas are strict, so an unknown field is a failure rather than something ignored, and a string carrying half of a character is refused before it can be stored. | Read details.issues. Each entry carries a path, a message and a machine readable code. Fix every named field and send the request again; the same body always fails the same way. |
| unauthorized | 401 | No credential was presented, or the key is unknown, revoked or expired, or an X-API-Key header carried something that is not an API key. details.reason says which. | Send Authorization: Bearer gsk_live_…. A revoked or expired key never starts working again, so issue a new one in the developer console. Put a dashboard session token in Authorization, never in X-API-Key. |
| forbidden_scope | 403 | The credential does not carry every scope the operation declares, or it is the wrong kind of credential for it. keys.* and assistant.* are user only and can never be called by a key. | details.requiredScopes and details.missingScopes name what is missing. A key's scopes cannot be changed after it is issued, so create a new key with them. When details.allowedActors is present, no key can call this operation at all. |
| not_found | 404 | No resource of that id belongs to this account. A resource that belongs to somebody else answers 404 as well, never 403. | Check the id. Do not treat this as a permissions problem. |
| rate_limited | 429 | The credential's per minute budget, the account's per minute ceiling, or a daily cap was exceeded. details.scope is minute, day or account, or global when the product's own daily cap on voice previews is spent. | Wait the Retry-After seconds and retry. details.limit and details.resetAt say what was hit and when it reopens. The RateLimit-* headers on every answer let a client pace itself before it gets here. |
| internal_error | 500 | An unhandled failure inside this API. The original message is logged and never answered. | Retry once, then quote requestId to support. A 5xx deletes the idempotency claim rather than storing it, so retrying under the same key is safe. |