Artifacts

Read the durable render status + shareable link for an artifact.

Returns the current theater (MP4) / audio (MP3) render status and the shareable link to watch or listen. Poll after POST /artifacts/{artifactId}/render-video until status is complete. A render that stopped with no job behind it reads failed (or stale over an earlier render) with its error saying so; POST render-video again to queue it. Scope: artifact:read.

get/artifacts/{artifactId}/render-video

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/artifacts/{artifactId}/render-video
  • Auth: HTTP bearer

Response

Current render status + shareable link.

artifactIdstring required
renderedVideoStatusstring

idle | queued | rendering | complete | stale | failed | needs_recording. A render that stopped with no job behind it reads failed, or stale over an earlier MP4, with renderedVideoError saying so: POST render-video again.

renderedAudioStatusstring

idle | queued | rendering | complete | stale | failed | needs_recording. A render that stopped with no job behind it reads failed, or stale over an earlier MP3 — or when the earlier MP3 could not be confirmed, with renderedAudioError saying so.

shareUrlstring

Shareable link to open/listen/watch the render.

Changes

No recorded changes to this operation across all 2 revisions of this API.