renders

What a render would cost

How many seconds a render of these OPTIONS would reserve, whether it would carry the free-tier watermark, and what the account has available — creating nothing and spending nothing. It prices the options only: there is no url field and the address does not change the price, so this is not the tool that records anything. A POST because the options are a body, not a query string; it is a read, safe to call as often as you like.

post/renders/quote

Request

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

Request body

backgroundstring
captionStylestring
capturestring
languagestring
maxSecondsinteger

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

orientationstring
targetSecondsinteger

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

templateIdstring
voiceIdstring

Response

What a render would cost

availableSecondsnumber required
cappedboolean required

True when the length asked for was reduced to fit the balance or the free-tier ceiling.

maxSecondsnumber nullable required
needednumber nullable required
secondsToReservenumber required

What renders.create would hold. Zero means nothing would be held (the free tier).

sufficientboolean required

False when the balance would refuse the render; needed says what it would take.

targetSecondsnumber nullable required
watermarkboolean required

Whether the video would carry the free-tier mark.

Changes

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