captions.get

Summary

Get detailed information about a specific caption paragraph.

Operation ID: captions.get
API member path: editor.doc.captions.get(...)
Mutates document: no
Idempotency: idempotent
Supports tracked mode: no
Supports dry run: no
Deterministic target resolution: yes

Expected result

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

Input fields

Field	Type	Required	Description
`target`	object(kind=“block”)	yes
`target.kind`	`"block"`	yes	Constant: `"block"`
`target.nodeId`	string	yes
`target.nodeType`	`"paragraph"`	yes	Constant: `"paragraph"`

Example request

{
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  }
}

Output fields

No fields.

Example response

{}

Pre-apply throws

TARGET_NOT_FOUND
CAPABILITY_UNAVAILABLE

Non-applied failure codes

None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "target": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "const": "block"
        },
        "nodeId": {
          "type": "string"
        },
        "nodeType": {
          "const": "paragraph"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "nodeId"
      ],
      "type": "object"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

Raw output schema

{
  "type": "object"
}

Getting Started

Editor

Document Engine

AI

Solutions

Resources

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Example request

​Output fields

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas