Artifacts

Rename a result: a table read, or a finished pitch deck or trailer (free).

Renames a result. A table read is called by the script it performs, so its new name is that script's title (the episode's, where it is one), as its share page and the Writers Lab show it; the pages are never touched. A finished pitch deck or trailer is renamed as its deck or trailer is. Free and reversible (rename it again). Any other kind of result is refused (400 validation_failed). Scope: story:write.

patch/artifacts/{artifactId}

Request

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

Request body

titlestring nullable required

The new name, at most 200 characters (trimmed).

Response

The renamed result.

artifactIdstring required
type'table_read' | 'pitch_deck' | 'trailer' required
titlestring required

The name it has now.

scriptIdstring nullable required

A table read: the script it performs, whose title it is.

jobIdstring nullable required

A pitch deck or trailer: its job id, which the deck and trailer endpoints take.

Changes

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