---
title: "What a render would cost"
method: POST
path: "/renders/quote"
tags: ["renders"]
---

# What a render would cost

`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

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.

## Request body

- object
  - `background` string
  - `captionStyle` string
  - `capture` string
  - `language` string
  - `maxSeconds` integer: The ceiling an Auto render may grow to, 1–600 seconds.
  - `orientation` string
  - `targetSeconds` integer: A fixed length, 1–600 seconds. Omit for Auto, which sizes itself and is capped by `maxSeconds`.
  - `templateId` string
  - `voiceId` string

## Response `200`

What a render would cost

- object
  - `availableSeconds` number, required
  - `capped` boolean, required: True when the length asked for was reduced to fit the balance or the free-tier ceiling.
  - `maxSeconds` number, nullable, required
  - `needed` number, nullable, required
  - `secondsToReserve` number, required: What `renders.create` would hold. Zero means nothing would be held (the free tier).
  - `sufficient` boolean, required: False when the balance would refuse the render; `needed` says what it would take.
  - `targetSeconds` number, nullable, required
  - `watermark` boolean, required: Whether the video would carry the free-tier mark.

## Other responses

- `400`: `validation_failed` — That request is not valid. · `options_invalid` — Those render options are not valid. · `template_unknown` — No such template. The catalogue is at GET /api/v1/catalog/render-options. · `voice_unknown` — No such voice. The catalogue is at GET /api/v1/catalog/voices. · `orientation_unknown` — No such orientation. The catalogue is at GET /api/v1/catalog/render-options. · `capture_unknown` — No such capture shape. The catalogue is at GET /api/v1/catalog/render-options. · `capture_incompatible` — Phone view only makes a portrait video. Pick a portrait orientation or a computer capture. · `avatar_unknown` — No such presenter. The catalogue is at GET /api/v1/catalog/render-options. · `avatar_unavailable` — The presenter circle is not available on this deployment. Make the video without one. · `caption_style_unknown` — No such caption style. The catalogue is at GET /api/v1/catalog/render-options. · `language_unknown` — No such language. The catalogue is at GET /api/v1/catalog/render-options. · `voice_language` — That voice does not speak the chosen language. Pick a voice listed for it. · `background_unknown` — No such background. The catalogue is at GET /api/v1/catalog/render-options. · `length_below_minimum` — That length is shorter than a walkthrough can be.
- `401`: `unauthorized` — Authentication is required.
- `403`: `forbidden_scope` — This credential does not carry the scope this operation needs.
- `404`: `not_found` — No such resource.
- `413`: `payload_too_large` — That request body is too large.
- `415`: `unsupported_media_type` — That content type is not supported.
- `429`: `rate_limited` — Too many requests. Try again shortly.
- `500`: `internal_error` — Something went wrong. Try again.

---

[API](https://skmtc.dev/gogoscreen/apis/gogoscreen-api.md) · [All operations](https://skmtc.dev/gogoscreen/apis/gogoscreen-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gogoscreen/apis/gogoscreen-api/revisions/2fd812319d75?raw)