Document apiReferenceImages

images.insertCaption

Insert a caption paragraph below the image.

mutates documentdry runnon-idempotent
doc.images.insertCaption(…)

Expected result

Returns an ImagesMutationResult with the image address.

Inputs

imageIdstringrequired
textstringrequired

Result

Output fields
successboolean
imageobject
failureobject

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • AMBIGUOUS_TARGET
  • INVALID_TARGET
2 more codes
  • CAPABILITY_UNAVAILABLE
  • INVALID_INPUT

Non-applied receipt codes

  • NO_OP

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas