Skip to main content
POST
Change the words painted over a frame of a stored previs, where they sit or the label behind them, without buying anything: the drawing stays and the card repaints. Reach for it when the person wants another line on a frame, one of its other_words or their own, or wants the words moved or boxed, on any frame of a hooks previs or a storyboard. Name only the frames that change; a frame you leave out keeps its words. Every call records a revision; from_revision brings an earlier revision back instead of naming frames. Show kind previs with this whole response so the repainted frame appears.

Authorizations

Authorization
string
header
required

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

Body

application/json
previs_id
string<uuid>
required

The Previs id returned by previs.create.

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)$
frames
object[]

The frames that change, each with any of the words, the place and the box. Omit when from_revision brings an earlier revision back.

Required array length: 1 - 4 elements
from_revision
integer

Bring this earlier revision's frames back as a new revision, instead of naming frames.

Required range: x >= 1
expected_revision
integer

The revision you last read; the write is refused as stale when the previs has moved on. Omit to write regardless.

Required range: x >= 1
what
string

What changed, in your words, kept on the revision; Dally writes one when omitted.

Maximum string length: 200
made_by
enum<string>
default:chat

chat when you call it from the conversation; the card sends card for the person's own tap.

Available options:
chat,
card

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