insertWhiteboardImage
Insert a real IMAGE (photo, screenshot, logo, picture) into a whiteboard — the storage-backed equivalent of insertImageInDocument. Provide the image as imageUrl (fetched and re-hosted), imageBase64, or imageBinary; for large files call createImageUploadSession(documentId) first then pass the returned assetUrl as imageUrl. The bytes are stored in the document-images bucket and the scene only holds a reference (never base64), exactly like pasted images. Options: caption (a text label placed + grouped beneath the image), width/height in px to RESIZE (if only one is given the other follows a 4:3 ratio; ~360px wide if neither), and placement via x/y (top-left) OR align ('left'|'center'|'right', positioned just below existing content) — omit both to auto-place to the right of the current content. After inserting, call getWhiteboardImage to verify. To move or resize the image later, patch its element via updateWhiteboardScene (mode:'patch' with {id, x, y, width, height}). For curated software-architecture ICONS (AWS/Docker/etc.) use addWhiteboardElements with an {type:'image', iconPath} spec instead.
Request
- Base URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1
- URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1/tools/insertWhiteboardImage
- Auth: HTTP bearer
Request body
Response
Tool result (shape varies per tool — refer to the tool's docs for the exact return value).
Changes
No recorded changes to this operation across all 1 revision of this API.