set_scene_image

Set a scene's still

Use an image the account already holds — a generation or an upload — as one scene's still, replacing the one it has. To make a new still instead, use generate_scene_images. One undo step; undo_storyboard takes it back. Spends no credits.

Scope

storyboards.write — Authors, edits, renders and deletes storyboards. Reading a board rides media.read, and the two board tools that spend need generation.write as well.

Behaviour

Writes: Creates or changes items in the caller's own account.
Can delete or overwrite: Can delete, overwrite, cancel or withdraw something the caller already has, so a host should confirm it.
Stays in the account: Stays inside the caller's private Kuro account: any media provider it calls acts on Kuro's account, and the result is visible to no one else.

Credits

What the tool's description says about credits, verbatim.

Spends no credits.

Inputs

storyboard_idstring · required
uuid
sceneinteger · required
> 0
referenceobject (type: "upload") or object (type: "generation") · required

Example call

A tools/call request with the required arguments only, each a placeholder read off the schema. Replace them before sending.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "set_scene_image",
    "arguments": {
      "storyboard_id": "00000000-0000-4000-8000-000000000000",
      "scene": 1,
      "reference": {
        "type": "upload",
        "upload_id": "00000000-0000-4000-8000-000000000000"
      }
    }
  }
}

Input schema

As the server sends it in tools/list.

{
  "type": "object",
  "properties": {
    "storyboard_id": {
      "type": "string",
      "format": "uuid"
    },
    "scene": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "reference": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "upload"
            },
            "upload_id": {
              "type": "string",
              "format": "uuid"
            }
          },
          "required": [
            "type",
            "upload_id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "generation"
            },
            "generation_id": {
              "type": "string",
              "format": "uuid"
            }
          },
          "required": [
            "type",
            "generation_id"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "storyboard_id",
    "scene",
    "reference"
  ],
  "additionalProperties": false
}

Related tools

generate_scene_images
Make the still pictures of the scenes you name.
undo_storyboard
Take back YOUR last gesture on a film, or redo the one you took back.

Every tool· This page as Markdown