Set the project's share image from the user's open R3 editor
r3_editor_set_preview_imageUse what the project's camera shows NOW, in the user's open R3 editor, as the project's share image: the picture its live page, link previews (social cards) and the showcase show, used when the project is next published (r3_publish_live, or Publish update in the editor). The editor waits until the scene's textures have loaded and takes it without edit aids (no grid, gizmos or outlines), as a visitor sees it; the answer is the picture it set. It is for once the project looks right (r3_editor_capture shows it beforehand), or when the user asks for a new picture. A live page keeps the share image of its live release until that next publish. Needs a tab with the project open and project:write.
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": {
"projectId": "<projectId>"
},
"name": "r3_editor_set_preview_image"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | A project open in the user's editor (r3_whoami lists them). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bytes | Yes | ||
| saved | Yes | ||
| width | Yes | ||
| answer | Yes | This answer in words: what was done, what R3 measured, decided or refused, and what to do next. The same text as the result's text block. Read it: the fields beside it are the data, this is the guidance. | |
| editor | Yes | ||
| height | Yes | ||
| mimeType | Yes | ||
| projectId | Yes |