vetkastar/text_overlay – API reference

vetkastar / text_overlay

Public
340 runs

Run vetkastar/text_overlay with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
image	string		Input image
text	string		Text to overlay on the image
font_size	integer	24	Font size (ignored if text_box is specified)
font_color	string	#000000	Font color in HEX format (ignored if gradient is specified)
font_file	string		Path to a local font file
font_url	string		URL to a Google Font
padding	string	10,10,10,10	Padding in pixels (top, right, bottom, left) (ignored if text_box is specified)
padding_pct	string		Padding in percentage (top, right, bottom, left) (ignored if text_box is specified)
outline_width	integer	0	Outline width in pixels
outline_color	string	#000000	Outline color in HEX format
opacity	number	100	Text opacity (0 to 100)
letter_spacing	integer	0	Letter spacing in pixels
text_align	string (enum)	left Options: left, center, right	Text alignment (ignored if text_box is specified)
font_style	string (enum)	none Options: none, bold, italic, underline	Font style
shadow_offset	integer	0	Shadow offset in pixels
shadow_color	string	#000000	Shadow color in HEX format
shadow_opacity	number	100	Shadow opacity (0 to 100)
glow_size	integer	0	Glow size in pixels
glow_color	string	#FFFFFF	Glow color in HEX format
rotation_slider	integer	0 Max: 360	Rotation angle in degrees (0 to 360)
text_only	boolean	False	Save only the text on a transparent background
gradient_start	string		Gradient start color in HEX format
gradient_end	string		Gradient end color in HEX format
gradient_type	string (enum)	linear Options: linear, radial	Gradient type
gradient_rotation	integer	0 Max: 360	Gradient rotation angle in degrees (0 to 360)
text_box	string		Text bounding box in pixels (left, top, right, bottom)
show_text_box	boolean	False	Show text bounding box

{
  "type": "object",
  "title": "Input",
  "required": [
    "image",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "title": "Text",
      "x-order": 1,
      "description": "Text to overlay on the image"
    },
    "image": {
      "type": "string",
      "title": "Image",
      "format": "uri",
      "x-order": 0,
      "description": "Input image"
    },
    "opacity": {
      "type": "number",
      "title": "Opacity",
      "default": 100,
      "x-order": 10,
      "description": "Text opacity (0 to 100)"
    },
    "padding": {
      "type": "string",
      "title": "Padding",
      "default": "10,10,10,10",
      "x-order": 6,
      "description": "Padding in pixels (top, right, bottom, left) (ignored if text_box is specified)"
    },
    "font_url": {
      "type": "string",
      "title": "Font Url",
      "x-order": 5,
      "description": "URL to a Google Font"
    },
    "text_box": {
      "type": "string",
      "title": "Text Box",
      "x-order": 25,
      "description": "Text bounding box in pixels (left, top, right, bottom)"
    },
    "font_file": {
      "type": "string",
      "title": "Font File",
      "format": "uri",
      "x-order": 4,
      "description": "Path to a local font file"
    },
    "font_size": {
      "type": "integer",
      "title": "Font Size",
      "default": 24,
      "x-order": 2,
      "description": "Font size (ignored if text_box is specified)"
    },
    "glow_size": {
      "type": "integer",
      "title": "Glow Size",
      "default": 0,
      "x-order": 17,
      "description": "Glow size in pixels"
    },
    "text_only": {
      "type": "boolean",
      "title": "Text Only",
      "default": false,
      "x-order": 20,
      "description": "Save only the text on a transparent background"
    },
    "font_color": {
      "type": "string",
      "title": "Font Color",
      "default": "#000000",
      "x-order": 3,
      "description": "Font color in HEX format (ignored if gradient is specified)"
    },
    "font_style": {
      "enum": [
        "none",
        "bold",
        "italic",
        "underline"
      ],
      "type": "string",
      "title": "font_style",
      "description": "Font style",
      "default": "none",
      "x-order": 13
    },
    "glow_color": {
      "type": "string",
      "title": "Glow Color",
      "default": "#FFFFFF",
      "x-order": 18,
      "description": "Glow color in HEX format"
    },
    "text_align": {
      "enum": [
        "left",
        "center",
        "right"
      ],
      "type": "string",
      "title": "text_align",
      "description": "Text alignment (ignored if text_box is specified)",
      "default": "left",
      "x-order": 12
    },
    "padding_pct": {
      "type": "string",
      "title": "Padding Pct",
      "x-order": 7,
      "description": "Padding in percentage (top, right, bottom, left) (ignored if text_box is specified)"
    },
    "gradient_end": {
      "type": "string",
      "title": "Gradient End",
      "x-order": 22,
      "description": "Gradient end color in HEX format"
    },
    "shadow_color": {
      "type": "string",
      "title": "Shadow Color",
      "default": "#000000",
      "x-order": 15,
      "description": "Shadow color in HEX format"
    },
    "gradient_type": {
      "enum": [
        "linear",
        "radial"
      ],
      "type": "string",
      "title": "gradient_type",
      "description": "Gradient type",
      "default": "linear",
      "x-order": 23
    },
    "outline_color": {
      "type": "string",
      "title": "Outline Color",
      "default": "#000000",
      "x-order": 9,
      "description": "Outline color in HEX format"
    },
    "outline_width": {
      "type": "integer",
      "title": "Outline Width",
      "default": 0,
      "x-order": 8,
      "description": "Outline width in pixels"
    },
    "shadow_offset": {
      "type": "integer",
      "title": "Shadow Offset",
      "default": 0,
      "x-order": 14,
      "description": "Shadow offset in pixels"
    },
    "show_text_box": {
      "type": "boolean",
      "title": "Show Text Box",
      "default": false,
      "x-order": 26,
      "description": "Show text bounding box"
    },
    "gradient_start": {
      "type": "string",
      "title": "Gradient Start",
      "x-order": 21,
      "description": "Gradient start color in HEX format"
    },
    "letter_spacing": {
      "type": "integer",
      "title": "Letter Spacing",
      "default": 0,
      "x-order": 11,
      "description": "Letter spacing in pixels"
    },
    "shadow_opacity": {
      "type": "number",
      "title": "Shadow Opacity",
      "default": 100,
      "x-order": 16,
      "description": "Shadow opacity (0 to 100)"
    },
    "rotation_slider": {
      "type": "integer",
      "title": "Rotation Slider",
      "default": 0,
      "maximum": 360,
      "minimum": 0,
      "x-order": 19,
      "description": "Rotation angle in degrees (0 to 360)"
    },
    "gradient_rotation": {
      "type": "integer",
      "title": "Gradient Rotation",
      "default": 0,
      "maximum": 360,
      "minimum": 0,
      "x-order": 24,
      "description": "Gradient rotation angle in degrees (0 to 360)"
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "type": "string",
  "title": "Output",
  "format": "uri"
}