Artifacts

Read a render's publishable state.

Returns whether the table-read render has been sent to Publishing (publishable), the durable full-mix render's status (renderStatus, recordingReady), and whether a live/published RSS release backs it (inFeed). An artifact that is not yours, or does not exist, is a 404 artifact_not_found. Costs nothing. Scope: artifact:read.

get/artifacts/{artifactId}/publish-state

Request

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

Response

The render's publish/render state.

artifactIdstring nullable required

The Story artifact behind the render.

publishableboolean required

True once the render has been sent to Publishing.

renderStatus'complete' | 'rendering' | 'needs_recording' | 'not_finalized' | 'failed' required

Normalized render status driving the publishing button's spinner/tooltip.

recordingReadyboolean required

True once the durable full-mix MP3 is ready to publish.

inFeedboolean required

True when a live/published release in an RSS feed backs this render.

Changes

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