marketing

Turn a scanned website into a marketing project

Build a marketing video from a scanned website: the scan is turned into planned scenes and words, and the result is a project with a first revision to edit and export. Send assist: true with assetUseConsent: true to have the words written for you, or a review block to use words a person already approved. Generating costs no video time — the EXPORT charges — but the account must be able to afford the film. Answers 202 with a Location; poll until state is terminal, then read projectId. One generation at a time.

post/marketing/generations

Request

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

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

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

The work was already known — the service recognised this key on its own record and queued nothing new. Answered when the 24-hour idempotency claim has expired but the work has not.

createdboolean required
resourceobject required

Changes

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