Trailer

Read a trailer's public watch-page state.

Read a trailer's public watch-page state: whether it is published, its shareUrl (the full public watch link, built server-side — relay it verbatim; never rebuild it from shareToken and writerSlug) and its master's state, or published: false with a null link while it is not shared. A finished trailer's watch page plays the finished cut for anyone holding the link, logged out, with nothing to edit, and is never indexed. Read-only; costs no credits. Scope: story:read.

get/trailers/{jobId}/share

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/trailers/{jobId}/share
  • Auth: HTTP bearer

Response

The trailer's share state: the live watch link and its master's state, or published: false with a null link.

jobIdstring required
titlestring nullable required

The trailer's own display name, or null when it is named from its theme and length.

publishedboolean required

True while the finished master has a live public watch page.

shareTokenstring nullable required

The trailer's share token — the t in its public watch link; null while it is not published.

writerSlugstring nullable required

The writer's public slug, where the shared trailer lives; null before the writer has one.

shareUrlstring nullable required

The trailer's full public watch link, built server-side. Relay it verbatim — never rebuild it from the token and slug. Null while it is not published.

renderedVideoStatusstring required

The master's state: idle, queued, rendering, complete, stale or failed.

Changes

No recorded changes to this operation across all 1 revision of this API.