Get Beat Sheet

GET

/api/creative/plot/beat-sheets/{template_id}

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Get a beat sheet template with its beats.

Parameters

Path Parameters

template_id

required

Template Id

string

Responses

200

Successful Response

BeatSheetTemplateDetailResponse

Template with beats response.

object

status

required

Status

Operation status

string

data

required

BeatSheetTemplateDetail

Template + beats

object

template

required

BeatSheetTemplate

The template

object

id

required

Id

Template UUID

string

projectId

Any of:

string

string

null

null

name

required

Name

Template name

string

description

Description

Template description

string

""

source

Source

Attribution (e.g. ‘Blake Snyder’)

string

""

createdAt

required

Createdat

Created timestamp (ms)

integer

modifiedAt

required

Modifiedat

Modified timestamp (ms)

integer

beats

required

Beats

Ordered beats

Array<object>

BeatSheetBeat

A single beat within a beat sheet template.

object

id

required

Id

Beat UUID

string

templateId

required

Templateid

Parent template

string

name

required

Name

Beat name (e.g. ‘Catalyst’, ‘Midpoint’)

string

description

Description

Beat description

string

""

targetPercent

required

Targetpercent

Target position as % of story

number

<= 100

sortOrder

required

Sortorder

Sort position

integer

act

Any of:

integer

integer

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object