Document apiReferenceCaptions

captions.get

Get detailed information about a specific caption paragraph.

read-onlyidempotent
doc.captions.get(…)

Expected result

Returns a CaptionInfo object with the caption's label, number, text, and instruction.

Inputs

targetobjectrequired
Fields
kind"block"required
nodeType"paragraph"required
nodeIdstringrequired

Result

Output fields

No fields.

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE

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