images

updateImageInDocument

Update image metadata (alt, caption, nlDescription, dimensions, alignment) — metadata only; to change the picture itself, delete it and insert the new one. Requires the document's versionTimestamp (from getDocument or any mutating tool's response) for optimistic locking.

post/tools/updateImageInDocument

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/updateImageInDocument
  • Auth: HTTP bearer

Request body

imageIdstring required

Image ID from IMAGE_OMITTED markers.

documentVersionTimestampnumber

Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.)

altstring

New alt text.

nlDescriptionstring

New image description.

captionstring

New caption.

widthnumber

Width in pixels.

heightnumber

Height in pixels.

align'left' | 'center' | 'right'

Alignment.

Response

Tool result (shape varies per tool — refer to the tool's docs for the exact return value).

object required

Changes

No recorded changes to this operation across all 1 revision of this API.