Storyboards

Get a storyboard

The document, its rev, every keyframe with the entity_ids its picture should be generated with (the present characters, their skins and mounts, the place; at most 12) and its image, the issues the page shows, and every path from the start to an ending with its length and timeline. readiness answers "ready for video?": ready, errors, advice and rows (where in the film, level, message, target), errors first. With ?format=script the answer is the whole film read top to bottom as Markdown (text/markdown; 409 if the storyboard was saved by a newer version of the app).

get/v1/storyboards/{id}

Request

  • Base URL: https://nanostudiopro.com/api
  • URL: https://nanostudiopro.com/api/v1/storyboards/{id}
  • Auth: HTTP bearer

Query parameters

format'script'

script answers the film as Markdown instead of JSON.

Response

The storyboard

idstring
namestring
project_idstring nullable
urlstring uri

The storyboard's page, where the owner watches.

revinteger
can_undoboolean
can_redoboolean
read_onlyboolean

Saved by a newer version of the app: doc is null and nothing can change.

docobject nullable

idea, cast, places, panels (keyframes), segments, decisions, cues, startPanelId, agentSpend; and when set: theme (the title music), sounds (the film's sound list), ambience (place id -> its sound), endScreens (ending keyframe id -> its end screen), mix (the sound layers' levels set by hand), score (the music on the timeline: cues, each {id, soundId, fromPanelId, toPanelId?, path?, offsetS?, fadeInS?, fadeOutS?, level?, scored?}); each take's effects (sound effects at a second of its clip: {id, soundId, atS, level?, pitch?, rise?}).

acknowledgedstring[]

The issue keys marked as intended (doc.acknowledged).

ai_feedbackobject

What the owner said of each AI continuity finding, by its key: {verdict: intended|wrong|correct, note?, at, version (of the check), text (what it said), takeIds}. Set with the mutation {op: "setAiFeedback", key, verdict, note?} (note up to 300 characters; verdict null clears it). "intended" also marks it as intended; "wrong" hides it and a re-run on the same takes does not raise it again; the note is told to the next check of that clip or cut.

Example response

{
  "issues": [
    {
      "rule": "continuity.outfit",
      "key": "segment:s1:continuity.outfit:mira"
    }
  ],
  "paths": [
    {
      "timeline": [
        {
          "enter": {
            "why": "same place"
          },
          "after_choice": {
            "why": "same place"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.