marketing

Would this generation be accepted?

Judge a generation request without starting one: the design exists, the manifest has the pictures it needs, the words would fit the frames, the brand is resolvable. Allocates nothing, spends nothing, creates nothing — it is a read in every sense but the verb, which is a POST because the request is a body. A refusal names the field, so a form can point at it before a customer waits for a video.

post/marketing/generations/preflight

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/marketing/generations/preflight
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

assetUseConsenttrue

Your consent to use the pictures the scan found on your own site.

assisttrue

Have the words written for you. Requires assetUseConsent.

audioMode'music' | 'silent' | 'voice' | 'voice-music'
brandChoice'saved' | 'website'
brandNamestring
briefobject

{ audience, objective, mustSay } — what the words should aim at.

durationSecondsinteger required

One the design offers at this format, from catalog.marketing.templates.list. The six-second edition is retired and is refused here.

expectedRevisionIdstring uuid
format'portrait' | 'landscape' | 'square' | 'four-five' required
musicobject

{ trackId } from the design's own catalogue.

narrationobject nullable

The voice the words are written FOR: { voiceId, language, cadence, synthesisSpeed? }. Absent means no spoken narration.

projectIdstring uuid

Re-generate INTO an existing project; requires expectedRevisionId.

reviewobject

The approved copy and scene choices. Judged by the campaign contract's own schema.

templateIdstring required

A design id from catalog.marketing.templates.list (family=website).

templateVersionstring
titlestring

Response

Would this generation be accepted?

object required

What the request would be accepted as: validity, the template version it resolved to, and whether copy is required. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.

Changes

No recorded changes to this operation across all 1 revision of this API.