Skip to main content
POST
Remember the hook the person chose. Call only after their explicit pick, or from the frame they tapped. This buys nothing and records a revision. Author its four-beat storyboard and call previs.create with this previs_id as parent_id when the person asks for the storyboard.

Authorizations

Authorization
string
header
required

A WorkOS-dashboard-issued internal API key on Authorization: Bearer.

Body

application/json
previs_id
string<uuid>
required

The completed hooks' Previs id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
index
integer
required

Zero-based frame: A=0, B=1, C=2, D=3.

Required range: 0 <= x <= 3

Response

Success. request_id is present on every response.

previs
object
required

The stored previs and its current state; dally_show kind previs takes this whole response.

show
object
required

How it is shown: dally_write renders this kind on this very answer with this whole response as its data, so the creator already sees it; do not render it again.

request_id
string
required

Server-minted id for this request. Present on every response, success and error — quote it when reporting a problem.

Minimum string length: 1