WEwearelearning
ScriptAssistant

GET /api/script-assistant/sessions/{sessionId}/storyboard

Request

  • Base URL
    https://api.wearelearning.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Implicit: https://login.wearelearning.io/authorize?audience=https://api.wearelearning.io

Path parameters

sessionIdstring required

Response

OK

renderJobIdstring nullable

Current render job. Null when the session has never had a deck rendered.

expectedSlideCountinteger nullable

The authoritative slide count once the render finishes, falling back to the claimed deck's advisory count while it is in progress. Null when neither is known yet.

isCompleteboolean required

True once the render finished, successfully or not - there is nothing more coming.

renderFailure'None' | 'TooLarge' | 'ConversionFailed' | 'SourceMissing' | 'CouldNotStart' required
renderFailurePageCountinteger nullable

Slides found, for the over-ceiling message.

renderFailureMaxSlidesinteger nullable

The ceiling that was exceeded, so the client need not know the configuration.

renderNarrationSource'None' | 'AiDraft' | 'SpeakerNotes'
narrationRequestState'NotAsked' | 'Declined' | 'Requested' | 'Completed' | 'Failed' required
storyCreationStatus'NotStarted' | 'InProgress' | 'Created' required
createdSimulationIdstring nullable

The story, once there is one. Null for every status but WeAreLearning.R2D2.Core.ScriptAssistant.Entities.SlideshowStoryCreationStatus.Created — a build under way has nothing to navigate into yet, which is exactly what lets the client tell "open it" from "keep waiting".

storyCreationCompletedboolean required

Whether the build behind WeAreLearning.R2D2.Api.DTO.ScriptAssistant.StoryboardDto.CreatedSimulationId has FINISHED — every slide a node, every node wired in.

storyCreationStoppedboolean required

Whether the build behind WeAreLearning.R2D2.Api.DTO.ScriptAssistant.StoryboardDto.CreatedSimulationId stopped without finishing, with every attempt used up (WE-2694). The storyboard offers Resume on this.

storyCreationMissingSlideCountinteger required

How many slides the finished story is missing, when a resumed build finished with what it could build and left the rest for the user to add in the editor. Zero for a complete story.

Changes

No recorded changes to this operation across all 1 revision of this API.