---
title: "The walkthrough render options"
method: GET
path: "/catalog/render-options"
tags: ["catalog"]
---

# The walkthrough render options

`GET /catalog/render-options`

## Request

- Base URL: `https://api.gogoscreen.com/api/v1`
- URL: `https://api.gogoscreen.com/api/v1/catalog/render-options`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Every choice a walkthrough render accepts: the look templates, the voices, the orientations, the capture sizes (with the pixel size each records at), the length presets, the languages, the backgrounds, and the caption styles (each with the style block it is drawn from, so a client can show a faithful sample). The ids here are the ids `renders.create` and `storyboards.create` take. `avatars` is present and EMPTY while the presenter circle is switched off on this deployment; an `avatarId` is not a field those operations take then.

## Response `200`

The walkthrough render options

- object
  - `autoMaxSeconds` object, required
    - `default` number, required
    - `max` number, required
    - `min` number, required
  - `avatars` object[], required
    - `description` string, nullable
    - `id` string, required
    - `isDefault` boolean
    - `name` string, required
  - `backgrounds` object[], required
    - `description` string, nullable
    - `id` string, required
    - `isDefault` boolean
    - `name` string, required
  - `captionStyles` object[], required: How burned-in captions look, for the look templates that burn them. Each row carries `look`, the style block the captions are actually drawn with.
    - `description` string, nullable
    - `id` string, required
    - `isDefault` boolean
    - `name` string, required
  - `captures` object[], required
    - `description` string, nullable
    - `id` string, required
    - `isDefault` boolean
    - `name` string, required
  - `languages` object[], required
    - `description` string, nullable
    - `id` string, required
    - `isDefault` boolean
    - `name` string, required
  - `lengths` object[], required
    - `key` string, required
    - `narration` boolean, required
    - `seconds` number, nullable, required
  - `minTargetSeconds` number, required
  - `orientations` object[], required
    - `description` string, nullable
    - `id` string, required
    - `isDefault` boolean
    - `name` string, required
  - `templates` object[], required
    - `description` string, nullable
    - `id` string, required
    - `isDefault` boolean
    - `name` string, required
  - `voices` object[], required
    - `description` string, nullable
    - `id` string, required
    - `isDefault` boolean
    - `name` string, required

## Other responses

- `400`: `validation_failed` — That request is not valid.
- `401`: `unauthorized` — Authentication is required.
- `403`: `forbidden_scope` — This credential does not carry the scope this operation needs.
- `404`: `not_found` — No such resource.
- `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)