marketing

Cut the finished video

Render one revision into a finished file, with cover, captions and transcript. THIS IS THE MARKETING OPERATION THAT SPENDS: time is reserved at the DELIVERED length (authored ÷ the revision's speed) and settled when the file is made; a cancelled or failed export is charged nothing. expectedRevisionId must be the current revision, or 409 revision_conflict with nothing reserved. Ask marketing.exports.quote first. Answers 202; at most three exports in flight.

post/marketing/projects/{id}/exports

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/marketing/projects/{id}/exports
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

The project to export.

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

audioMode'music' | 'silent' | 'voice' | 'voice-music'

Defaults to music.

coverTextstring nullable

Words for the cover image, for THIS export only. Blank means none; it is never written back to the revision.

durationSecondsinteger required

One the design offers at this format, and the one the named revision was saved with. The six-second edition is retired and is refused here.

expectedRevisionIdstring uuid required

The revision you are exporting. It must still be the project's current one.

formatstring required

One the design offers: landscape | portrait | square | four-five.

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

Changes

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