templates.get

One render template

GET/templates/{id}

Operation: templates.get
MCP tool: templates_get

One template by id: either one this account saved or one of the system templates. A template id belonging to another account answers 404, because ownership is part of the resolution rather than a check after it.

curl 'https://api.gogoscreen.com/api/v1/templates/3f2b0c1a-9d4e-4a61-b8c2-000000000012' \
  -H "Authorization: Bearer $GOGOSCREEN_API_KEY"

A request to this operation.

json

{
  "template": {
    "id": "3f2b0c1a-9d4e-4a61-b8c2-000000000012",
    "name": "Product tour, portrait",
    "description": "Phone view, 60 seconds, English.",
    "isDefault": false,
    "custom": true,
    "limits": {
      "editor": {},
      "executor": {},
      "render": {}
    },
    "voiceId": null,
    "lengthPreset": null,
    "orientationId": null,
    "captureId": null,
    "language": null,
    "background": null,
    "ttsSpeed": null,
    "sourceRenderId": null,
    "updatedAt": "2026-09-21T11:17:00.000Z"
  }
}

200 response, captured from a real call. Ids, timestamps and signed URLs are replaced; the shape is untouched.

At a glance

Fact	Detail
Scopes	`renders:read`
Credentials	a signed in dashboard session or an API key.
Rate limit	600 requests a minute per credential, in the `read` class.
Idempotency	Not applicable. This operation changes nothing.
MCP tool	`templates_get`
Always sets	`Cache-Control: private, no-store`

Path parameters

Name	Type	Required	Description
id	string	Required	The template's id — the `id` a create call answered with, or one from `templates.list`. A template id is not a uuid.1–64 characters

Response

Answers 200. Every answer also carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, and every error body carries a requestId.

200 OK

One render template

200 OK body

Name

Type

Description

template

object

17 fields inside template

Name	Type	Description
background	string \| null
captureId	string \| null
custom	boolean	true for one of this account's saved templates, false for a system template.
description	string
id	string
isDefault	boolean
language	string \| null
lengthPreset	string \| null
limits	object \| null	The engine limits this template pins. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys
name	string
orientationId	string \| null
sourceRenderId	string \| null
speedFactor	number \| null	System templates only: a factor on the voice's own speed.
ttsSpeed	number \| null
updatedAt	string \| null	format: date-time
voiceId	string \| null
voiceStyle	string \| null	System templates only: the delivery the narrator reads in.

200 OK headers
Header	Meaning
`Cache-Control`	Always `private, no-store`.

Errors

Every refusal is { error: { code, message, details?, requestId } }. Branch on code, never on the sentence. The full catalogue is at Errors.

Code	Status	When it happens	What to do
validation_failed	400	The merged path, query and body did not match the operation's schema. The schemas are strict, so an unknown field is a failure rather than something ignored, and a string carrying half of a character is refused before it can be stored.	Read `details.issues`. Each entry carries a `path`, a `message` and a machine readable `code`. Fix every named field and send the request again; the same body always fails the same way.
unauthorized	401	No credential was presented, or the key is unknown, revoked or expired, or an `X-API-Key` header carried something that is not an API key. `details.reason` says which.	Send `Authorization: Bearer gsk_live_…`. A revoked or expired key never starts working again, so issue a new one in the developer console. Put a dashboard session token in `Authorization`, never in `X-API-Key`.
forbidden_scope	403	The credential does not carry every scope the operation declares, or it is the wrong kind of credential for it. `keys.` and `assistant.` are user only and can never be called by a key.	`details.requiredScopes` and `details.missingScopes` name what is missing. A key's scopes cannot be changed after it is issued, so create a new key with them. When `details.allowedActors` is present, no key can call this operation at all.
not_found	404	No resource of that id belongs to this account. A resource that belongs to somebody else answers 404 as well, never 403.	Check the id. Do not treat this as a permissions problem.
rate_limited	429	The credential's per minute budget, the account's per minute ceiling, or a daily cap was exceeded. `details.scope` is `minute`, `day` or `account`, or `global` when the product's own daily cap on voice previews is spent.	Wait the `Retry-After` seconds and retry. `details.limit` and `details.resetAt` say what was hit and when it reopens. The `RateLimit-*` headers on every answer let a client pace itself before it gets here.
internal_error	500	An unhandled failure inside this API. The original message is logged and never answered.	Retry once, then quote `requestId` to support. A 5xx deletes the idempotency claim rather than storing it, so retrying under the same key is safe.