Artifacts

Read actual script content for a table read artifact.

Returns the parsed backing entries used by theater playback, music, SFX, and coverage. Use scope=page, scope=scene, scope=character, or scope=range for focused reads. Terminal agents should call this before answering questions about what is on a page, which scene is strongest, or what a character says. Scope: artifact:read.

get/artifacts/{artifactId}/script

Request

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

Query parameters

scope'all' | 'page' | 'scene' | 'character' | 'range'

Selection scope. Defaults to all.

pageinteger

Required when scope=page.

sceneIndexinteger

Required when scope=scene. Scene indexes are zero-based and listed in the response scenes array.

characterstring

Required when scope=character. Use names from the response characters array.

startEntryinteger

Required when scope=range.

endEntryinteger

Required when scope=range.

limitinteger

Maximum selected entries returned. Default 250, max 500.

Response

Script content envelope.

Changes

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