Save a generated frame
save_frameSave one generation from a design thread as a real frame in this operator's frame list, with its photo windows cut out. Call it only when the operator has chosen a result — pass the threadId and generationId that check_generation returned for it. This CREATES a frame: saving the same generation twice makes two frames, so do not retry a call that may have gone through. The frame is private to the account unless the operator explicitly asks for it to be shared. After saving, the operator picks the frame in a booth's frame settings; this tool does not assign it to a booth, and there is no tool that edits or deletes a frame.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"threadId": "<threadId>",
"generationId": "<generationId>"
},
"name": "save_frame"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | What the operator will see in their frame list. Use their words if they named it; otherwise derived from the description. | |
| isPublic | No | Leave unset unless they explicitly ask to share it. Default is private to their account. | |
| threadId | Yes | The design thread the generation belongs to. | |
| generationId | Yes | The generation to save, from check_generation. Each version in a thread has its own id. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| name | No | ||
| state | Yes | ||
| frameId | No | ||
| isPublic | No | ||
| threadId | No | ||
| canvasWidth | No | ||
| canvasHeight | No | ||
| dashboardUrl | No | ||
| generationId | No | ||
| thumbnailUrl | No | ||
| placeholderCount | No |