DocxInsertImageRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-docx-insert-image-request-schema.json",
  "title": "DocxInsertImageRequest",
  "description": "Input to set-footer command",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudmersive-editdocument-api-openapi.yml#/components/schemas/DocxInsertImageRequest",
  "type": "object",
  "properties": {
    "InputDocumentFileBytes": {
      "format": "byte",
      "description": "Optional: Bytes of the input file to operate on",
      "type": "string"
    },
    "InputDocumentFileUrl": {
      "description": "Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).",
      "type": "string"
    },
    "InputImageFileBytes": {
      "format": "byte",
      "description": "Optional: Bytes of the input image file to operate on; if you supply this value do not supply InputImageFileUrl or ImageToAdd.",
      "type": "string"
    },
    "InputImageFileUrl": {
      "description": "Optional: URL of an image file to operate on as input; if you supply this value do not supply InputImageFileBytes or ImageToAdd.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).",
      "type": "string"
    },
    "ImageToAdd": {
      "$ref": "#/$defs/DocxImage",
      "description": "Optional: Image to add; if you supply in this object, do not supply InputImageFileBytes or InputImageFileUrl."
    },
    "InsertPlacement": {
      "description": "Optional; default is DocumentEnd.  Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)",
      "type": "string"
    },
    "InsertPath": {
      "description": "Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object.  Used with InsertPlacement of BeforeExistingObject or AfterExistingObject",
      "type": "string"
    },
    "WidthInEMUs": {
      "format": "int64",
      "description": "Optional: The width of the image in EMUs",
      "type": "integer"
    },
    "HeightInEMUs": {
      "format": "int64",
      "description": "Optional: The height of the image in EMUs",
      "type": "integer"
    }
  },
  "$defs": {
    "DocxImage": {
      "type": "object",
      "properties": {
        "Path": {
          "description": "The Path of the location of this object; leave blank for new tables",
          "type": "string"
        },
        "ImageName": {
          "description": "The Name of the image",
          "type": "string"
        },
        "ImageId": {
          "format": "int64",
          "description": "The Id of the image",
          "type": "integer"
        },
        "ImageDescription": {
          "description": "The Description of the image",
          "type": "string"
        },
        "ImageWidth": {
          "format": "int64",
          "description": "Width of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height",
          "type": "integer"
        },
        "ImageHeight": {
          "format": "int64",
          "description": "Height of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height",
          "type": "integer"
        },
        "XOffset": {
          "format": "int64",
          "description": "X (horizontal) offset of the image",
          "type": "integer"
        },
        "YOffset": {
          "format": "int64",
          "description": "Y (vertical) offset of the image",
          "type": "integer"
        },
        "ImageDataEmbedId": {
          "description": "Read-only; internal ID for the image contents",
          "type": "string"
        },
        "ImageDataContentType": {
          "description": "Read-only; image data MIME content-type",
          "type": "string"
        },
        "ImageInternalFileName": {
          "description": "Read-only; internal file name/path for the image",
          "type": "string"
        },
        "ImageContentsURL": {
          "description": "URL to the image contents; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the contents.",
          "type": "string"
        },
        "InlineWithText": {
          "description": "True if the image is inline with the text; false if it is floating",
          "type": "boolean"
        }
      }
    }
  }
}