Skip to main content
The story builder: nodes, links, references and sharing. 12 operations. How to call them, and what the answers mean: Operations reference.
Generated from the operation catalog: src/lib/ops/public-catalog.json in publicsummerengine at 0d85f61e2b and the summer-engine npm package 4.0.0 for engine and local operations. If something here is wrong, the operation’s definition is wrong.

add_reference

stories.add_reference: Add a reference to a story node Add a new reference (a picture, a link, a note) to a story node: it joins the workspace’s references and is attached to the node. Returns the reference. Next: stories.get. Inputs:
Example: Pin a picture to Mira.

archive_node

stories.archive_node: Archive a story node Ask the person to archive a story node: it leaves the story builder for everyone in the workspace. Returns a link; nothing changes until they confirm. Next: jobs.wait. Inputs:
Example: A character that was cut.

attach_reference

stories.attach_reference: Attach a reference to a story node Attach one of the workspace’s existing references to a story node. Returns the attachment. Next: stories.get. Inputs:
Example: Reuse the harbor picture.

create_node

stories.create_node: Create a story node Create a story node in a workspace: a world, character, place, faction, arc, quest or scene, with its title and optional text and tags. Returns the node. Next: stories.link_nodes or stories.add_reference. Inputs:
Example: Add a character.

detach_reference

stories.detach_reference: Detach a reference from a story node Ask the person to detach a reference from a story node (linkId from stories.get references); the reference stays in the workspace. Returns a link; nothing changes until they confirm. Next: jobs.wait. Inputs:
Example: That picture is not Mira any more.

get

stories.get: Read a story node Read one story node: its text, kind, tags and status, its links to other nodes (with their link ids) and its references (with their link ids). Next: stories.update_node. Inputs:
Example: Read the hero’s node.

stories.link_nodes: Link two story nodes Link two story nodes in a workspace (a character to a place, an arc to a quest) with a link type and an optional label. Returns the link. Next: stories.get. Inputs:
Example: Mira lives in the harbor.

list

stories.list: List story nodes List the story builder’s nodes in a workspace (world, characters, places, factions, arcs, quests, scenes): id, kind, title, summary and tags. Filter by kind or words. Next: stories.get with a nodeId. Inputs:
Example: Who are the characters?

save_view

stories.save_view: Save a story graph view Save where each story node sits on the graph and its kind filter, as a named view of the workspace (a new one, or viewId to replace one). Returns the view. Next: stories.list. Inputs:
Example: Keep the layout.

share

stories.share: Share a story with a team Ask the person to move their story builder content into a team the members see: an existing team (targetWorkspaceId) or a new one (newTeamName). Returns a link; nothing moves until they confirm. Next: jobs.wait. Inputs:
Example: The team should see the story.

stories.unlink_nodes: Remove a link between story nodes Ask the person to remove a link between two story nodes (linkId from stories.get of one of them). Returns a link to approve; nothing changes until they confirm. Next: jobs.wait. Inputs:
Example: Mira no longer lives in the harbor.

update_node

stories.update_node: Change a story node Change a story node’s title, kind, summary, text, status or tags; fields left out stay as they are. Returns the node. Next: stories.get. Inputs:
Example: Rewrite a summary.