Artifacts

Send a render to Publishing, or remove it.

Marks the table-read render publishable (action: "mark") so it surfaces in Publishing and becomes eligible for an RSS/podcast feed — ensuring the durable full-mix render exists first, free and replay-guarded — or removes it (action: "unmark"). FREE and naturally idempotent: no Idempotency-Key. An unmark a live/published RSS release backs comes back { requiresConfirm: true, inFeed: true } until sent again with confirm: true. An artifact that is not yours, or does not exist, is a 404 artifact_not_found; a mark whose durable render cannot start refuses before the flag is set. Scope: artifact:publish.

post/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

Request body

action'mark' | 'unmark' required

mark | unmark.

confirmboolean

Only read for action: "unmark". Without it, a render a live/published RSS release backs comes back { requiresConfirm: true, inFeed: true } instead of being removed.

Response

The render's publish state after the change.

artifactIdstring nullable

The Story artifact behind the render.

publishableboolean

True once the render has been sent to Publishing.

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

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

renderRequest'complete' | 'rendering'

Present on a mark that also ensured the durable render: complete when it already existed, rendering when it was just queued.

requiresConfirmboolean

Present (true) on an unmark a live feed backs, until confirm: true is sent.

Changes

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