Skip to main content
PATCH
Edit one scene's narration or on-screen text

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

id
string
required
sceneId
string
required
Example:

"governance"

Body

application/json
field
string
required

narration or a props text path

Example:

"items/1/text"

text
string
required
Example:

"Your knowledge stays in the IP Vault"

revision
integer
required

The revision number the edit was made on (the head's headRevision)

Example:

3

Response

Saved as a new version — or unchanged: true (same text, nothing saved; revision is the current one)

success
boolean
Example:

true

unchanged
boolean

Present (true) only when the text was already that

presentationId
string
sceneId
string
field
string
revision
integer
Example:

4

version
integer

The new version (each edit is its own version)

Example:

2

narrationChanged
boolean
narrationQueued
boolean

The narration of the new version is being made

estimatedTotal
number | null

Projected video length (narration edits)

Example:

64.1

presenterRerecord
boolean

The Digital Twin's face will be recorded again

presenterCreditsEstimate
number | null

Estimated credits for that recording

contentValid
boolean
report
object