Add reference images
add_reference_imagesAdd stored images to a group as image nodes and connect each one to a node of the group, exactly like dropping the files into the group and connecting them in the app: the image's @# token is appended to the node's text. Default target per group (defaultNodeId in get_group): a shot's panel generator ({ kind: "shot", id }), the starred generator of a shot's production group or the art direction, and for a story element ({ kind: "story_element", id, group }) its Story element node, whose stage body for that group then cites the image. nodeId picks another generator or text node of the group; nodes the app would not connect an image to are refused. mediaIds come from import_media (pages and crops) or from get_group / view_media. An image already in the group is reused, so calling again does not duplicate it. The token alone does not tell a generator what to do with the image: when the image is a board the panel should redraw, or a reference the user gave a purpose for, rewrite the prompt with set_prompt in the same run (see the storyboard guide). A model takes a limited number of reference images: the call fails without writing anything when a generator's prompt would cite more. No images are generated and no credits are spent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| nodeId | No | A node of the group from get_group (nodeId): a generator, a text node or the Story element node. Omit for the group's default target (defaultNodeId in get_group): a shot's panel, the starred generator of a production group or the art direction, a story element's Story element node. | |
| target | Yes | The group, e.g. { kind: "shot", id: shotId } for a shot's panel group, { kind: "story_element", id: entityId } for a reference sheet, { kind: "art_direction" }. | |
| mediaIds | Yes | Images to add, as media ids from import_media, view_media or get_group (max 8). | |
| projectId | Yes | ScreenWeaver project id (from list_projects). |