Reveal Share Link Token | SpeechifyAI API

Return a share link’s bearer token, so the URL can be copied again.

A POST rather than a GET, and permission-gated like a mutation even though it changes nothing: the response is a live bearer credential, so it must never be cacheable or replayable from a browser’s history, and whoever may hand a link out is whoever may hand it out again. It is separately rate-limited.

Revoked and expired links still reveal — the owner can already see that state and may need to tell a recipient which link they hold.

Links created before tokens were stored recoverably return 409 share_link_token_unavailable: theirs was not kept, and no retry will produce it. Check token_recoverable on the link first rather than offering an action that can only fail.

Return a share link's bearer token, so the URL can be copied again. A `POST` rather than a `GET`, and permission-gated like a mutation even though it changes nothing: the response is a live bearer credential, so it must never be cacheable or replayable from a browser's history, and whoever may hand a link out is whoever may hand it out again. It is separately rate-limited. Revoked and expired links still reveal — the owner can already see that state and may need to tell a recipient which link they hold. Links created before tokens were stored recoverably return `409 share_link_token_unavailable`: theirs was not kept, and no retry will produce it. Check `token_recoverable` on the link first rather than offering an action that can only fail.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

agent_idstringRequired

Agent id (prefixed external id, agent_...).

share_link_idstringRequiredformat: "^share_[0-9a-hjkmnp-tv-z]{26}$"

Share link id (prefixed external id, share_...).

Response headers

Speechify-Request-IdstringOptional

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a Speechify-Request-Id request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests

it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

The legacy alias X-Request-ID carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a `Speechify-Request-Id` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope. The legacy alias `X-Request-ID` carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Response

The link's bearer token.

tokenstring

The link's opaque bearer token.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error