DrawTextRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-draw-text-request-schema.json",
  "title": "DrawTextRequest",
  "description": "Request to draw one or more pieces of text onto an image",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudmersive-edit-api-openapi.yml#/components/schemas/DrawTextRequest",
  "type": "object",
  "properties": {
    "BaseImageBytes": {
      "format": "byte",
      "description": "Image to draw text on, in bytes.  You can also use the BaseImageUrl instead to supply image input as a URL",
      "type": "string"
    },
    "BaseImageUrl": {
      "description": "Image to draw text on, as an HTTP or HTTPS fully-qualified URL",
      "type": "string"
    },
    "TextToDraw": {
      "description": "One or more pieces of text to draw onto the image",
      "type": "array",
      "items": {
        "$ref": "#/$defs/DrawTextInstance"
      }
    }
  },
  "$defs": {
    "DrawTextInstance": {
      "description": "Text instance to draw on an image",
      "type": "object",
      "properties": {
        "Text": {
          "description": "Text string to draw",
          "type": "string"
        },
        "FontFamilyName": {
          "description": "Font Family to use.  Leave blank to default to \"Arial\".  Supported fonts including Arial, Calibri, Cambria, Candara, Consolas, Constantia, Corbel, Courier New, Courier Regular, Georgia, Impact Regular, Lucida, Modern Regular, Tahoma, Times New Roman, Verdana",
          "type": "string"
        },
        "FontSize": {
          "format": "double",
          "description": "Font size to use.",
          "type": "number"
        },
        "Color": {
          "description": "Color to use - can be a hex value (with #) or HTML common color name",
          "type": "string"
        },
        "X": {
          "format": "double",
          "description": "Pixel location of the left edge of the text location",
          "type": "number"
        },
        "Y": {
          "format": "double",
          "description": "Pixel location of the top edge of the text location",
          "type": "number"
        },
        "Width": {
          "format": "double",
          "description": "Width in pixels of the text box to draw the text in; text will wrap inside this box",
          "type": "number"
        },
        "Height": {
          "format": "double",
          "description": "Height in pixels of the text box to draw the text in; text will wrap inside this box",
          "type": "number"
        }
      }
    }
  }
}