create.image

Summary

Insert a new image at the target position.

Operation ID: create.image
API member path: editor.doc.create.image(...)
Mutates document: yes
Idempotency: non-idempotent
Supports tracked mode: yes
Supports dry run: yes
Deterministic target resolution: yes

Expected result

Returns a CreateImageResult with the new image address.

Input fields

Field	Type	Required	Description
`alt`	string	no
`at`	object(kind=“documentStart”) \| object(kind=“documentEnd”) \| object(kind=“before”) \| object(kind=“after”) \| object(kind=“inParagraph”)	no	One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”), object(kind=“inParagraph”)
`in`	StoryLocator	no	StoryLocator
`size`	object	no
`size.height`	number	no
`size.width`	number	no
`src`	string	yes
`title`	string	no

Example request

{
  "alt": "example",
  "in": {
    "kind": "story",
    "storyType": "body"
  },
  "src": "example"
}

Output fields

Field	Type	Required
`failure`	object	no
`image`	object	no
`success`	boolean	no

Example response

{
  "image": {},
  "success": true
}

Pre-apply throws

TARGET_NOT_FOUND
INVALID_TARGET
CAPABILITY_UNAVAILABLE
INVALID_INPUT
STORY_NOT_FOUND
STORY_MISMATCH
STORY_NOT_SUPPORTED
CROSS_STORY_PLAN
MATERIALIZATION_FAILED

Non-applied failure codes

INVALID_TARGET
INVALID_INPUT

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "alt": {
      "type": "string"
    },
    "at": {
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "documentStart"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "documentEnd"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "before"
            },
            "target": {
              "$ref": "#/$defs/BlockNodeAddress"
            }
          },
          "required": [
            "kind",
            "target"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "after"
            },
            "target": {
              "$ref": "#/$defs/BlockNodeAddress"
            }
          },
          "required": [
            "kind",
            "target"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "inParagraph"
            },
            "offset": {
              "type": "integer"
            },
            "target": {
              "$ref": "#/$defs/BlockNodeAddress"
            }
          },
          "required": [
            "kind",
            "target"
          ],
          "type": "object"
        }
      ]
    },
    "in": {
      "$ref": "#/$defs/StoryLocator"
    },
    "size": {
      "additionalProperties": false,
      "properties": {
        "height": {
          "type": "number"
        },
        "width": {
          "type": "number"
        }
      },
      "type": "object"
    },
    "src": {
      "type": "string"
    },
    "title": {
      "type": "string"
    }
  },
  "required": [
    "src"
  ],
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "type": "object"
    },
    "image": {
      "type": "object"
    },
    "success": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "image": {
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "image"
  ],
  "type": "object"
}

Raw failure schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "INVALID_TARGET",
            "INVALID_INPUT"
          ]
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "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