Document apiReferenceCaptions

captions.list

List all caption paragraphs in the document.

read-onlyidempotent
doc.captions.list(…)

Expected result

Returns a CaptionsListResult containing discovered captions with address and domain data.

Inputs

labelstring
limitinteger
offsetinteger

Result

Output fields

No fields.

Failures

Pre-apply throws

  • CAPABILITY_UNAVAILABLE
  • INVALID_INPUT

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