renders

Make a walkthrough video from a URL

Work through a live website and turn the recording into a narrated video. Time is RESERVED when it is queued and settled at the finished file's measured length; a failed or cancelled render is charged nothing. This is the tool that records; renders.quote prices the same options and starts nothing. Answers 202 with a Location; poll until state is terminal, then renders.download. At most three renders in flight per account.

post/renders

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/renders
  • 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

backgroundstring

What sits around the recording: studio (the default) puts the whole window on a quiet backdrop, none lets it fill the frame. Ids from catalog.renderOptions.

captionStylestring

How burned-in captions look, as an id from catalog.renderOptions.captionStyles. It only reaches the frame on a look template that burns captions (captioned); on any other template the choice is recorded and nothing is drawn. Omit for the catalogue default.

capturestring

The shape of the recording: a computer window or a phone view.

hintstring required

What to show, in a sentence: "show the invoice creation flow".

languagestring
maxSecondsinteger

The ceiling an Auto video may grow to, 1–600 seconds.

orientationstring
targetSecondsinteger

A fixed length, 1–600 seconds. Omit for Auto, which sizes itself to what it finds and is capped by maxSeconds.

templateIdstring

A saved or system template id from catalog.renderOptions.

urlstring required

The page to start from. Public addresses only; a private or link-local address is refused.

voiceIdstring

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.