getText

Extract the plain-text content of the document.

Summary

Extract the plain-text content of the document.

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

Expected result

Returns the full plain-text content of the document as a string.

Input fields

Field	Type	Required	Description
in	StoryLocator	no	StoryLocator

Example request

{
  "in": {
    "kind": "story",
    "storyType": "body"
  }
}

Output fields

No fields.

Example response

"example"

Pre-apply throws

• STORY_NOT_FOUND
• STORY_MISMATCH
• STORY_NOT_SUPPORTED
• CROSS_STORY_PLAN
• MATERIALIZATION_FAILED

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "in": {
      "$ref": "#/$defs/StoryLocator"
    }
  },
  "type": "object"
}

Raw output schema

{
  "type": "string"
}