Skip to content
Ishvana Ishvana Docs

Create Beat Sheet

POST
/api/creative/plot/beat-sheets

Create a custom beat sheet template.

Request Body required

Section titled “Request Body required ”
BeatSheetCreateRequest

Create a custom beat sheet template.

object
name
required
Name

Template name

string
>= 1 characters <= 200 characters
description
Description

Template description

string
""
source
Source

Attribution

string
""
beats
required
Beats

Beats to create

Array<object>
BeatCreateRequest

A single beat within a BeatSheetCreateRequest.

object
name
required
Name

Beat name

string
>= 1 characters <= 200 characters
description
Description

Beat description

string
""
targetPercent
required
Targetpercent

Target position %

number
<= 100
act
Any of:
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

BeatSheetTemplateResponse

Single template response.

object
status
required
Status

Operation status

string
data
required
BeatSheetTemplate

The template

object
id
required
Id

Template UUID

string
projectId
Any of:
string
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

422

Section titled “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