voices.preview

Hear a voice

POST/voices/preview

Operation: voices.preview
MCP tool: voices_preview

Synthesise a short sentence in one of the catalogue's voices and answer a short-lived link to the audio. Send your own text (up to 300 characters) or omit it for a stock sentence. The same sentence in the same voice is only ever synthesised once, so repeating a preview is free and instant. When somebody else is synthesising this exact preview at this moment the answer is status: "preview_pending" with no URL — ask again in a second.

curl -X POST "https://api.gogoscreen.com/api/v1/voices/preview" \
  -H "Authorization: Bearer $GOGOSCREEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "voiceId": "<voiceId>" }'

A request to this operation.

At a glance

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

Request body

A JSON body is required. Unknown fields are refused rather than ignored, so a typo is a 400 validation_failed rather than a setting that silently did nothing.

Name	Type	Required	Description
voiceId	string	Required	A voice id from catalog.voices.list.1–64 characters
text	string	Optional	The sentence to speak. Omit for a stock one.max 300 characters

Response

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

200 OK

Hear a voice

200 OK body
Name	Type	Description
cached	boolean	True when the audio already existed and nothing was synthesised.
expiresAt	string \| null	format: date-time
status	string	one of: ready, preview_pending
url	string \| null	A signed link to the audio. Null while the preview is still being made.

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.
voice_unknown	400	The `voiceId` named is not in the catalogue.	Read `GET /catalog/voices` and send an id it lists.
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.
payload_too_large	413	The request body is over the transport's limit: 256 kb over HTTP, 1 mb over MCP.	Send less. `details.limit` carries the limit. Version 1 has no upload operations, so a body this size is usually a mistake.
unsupported_media_type	415	The request carried a body whose `Content-Type` is not `application/json`, whose charset is not utf-8, or whose `Content-Encoding` this API does not decode. A body nobody can read would otherwise be silently discarded.	Send `Content-Type: application/json` and utf-8 bytes. `details` names the charset, encoding or content type that was objected to.
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.
preview_failed	502	The voice preview could not be made.	Try again shortly. The same sentence in the same voice is only ever synthesised once, so a successful retry is free.
storage_unavailable	503	File storage could not be reached, so no signed URL could be created.	Back off and retry. The file itself is unaffected.
tts_unavailable	503	Speech is not configured on this deployment, so no voice preview can be made.	Nothing a caller can change. Ask the operator.