vetkastar/text_overlay – Run with an API on Replicate

vetkastar / text_overlay

Cold

Public
743 runs
CPU

Run with an API

Playground API Examples README Versions

Input

image

*file

Input image

text

*string

Shift + Return to add a new line

Text to overlay on the image

font_size

integer

Font size (ignored if text_box is specified)

Default: 24

font_color

string

Shift + Return to add a new line

Font color in HEX format (ignored if gradient is specified)

Default: "#000000"

font_file

file

Path to a local font file

font_url

string

Shift + Return to add a new line

URL to a Google Font

padding

string

Shift + Return to add a new line

Padding in pixels (top, right, bottom, left) (ignored if text_box is specified)

Default: "10,10,10,10"

padding_pct

string

Shift + Return to add a new line

Padding in percentage (top, right, bottom, left) (ignored if text_box is specified)

outline_width

integer

Outline width in pixels

Default: 0

outline_color

string

Shift + Return to add a new line

Outline color in HEX format

Default: "#000000"

opacity

number

Text opacity (0 to 100)

Default: 100

letter_spacing

integer

Letter spacing in pixels

Default: 0

text_align

string

Text alignment (ignored if text_box is specified)

Default: "left"

font_style

string

Font style

Default: "none"

shadow_offset

integer

Shadow offset in pixels

Default: 0

shadow_color

string

Shift + Return to add a new line

Shadow color in HEX format

Default: "#000000"

shadow_opacity

number

Shadow opacity (0 to 100)

Default: 100

glow_size

integer

Glow size in pixels

Default: 0

glow_color

string

Shift + Return to add a new line

Glow color in HEX format

Default: "#FFFFFF"

rotation_slider

integer

(minimum: 0, maximum: 360)

Rotation angle in degrees (0 to 360)

Default: 0

text_only

boolean

Save only the text on a transparent background

Default: false

gradient_start

string

Shift + Return to add a new line

Gradient start color in HEX format

gradient_end

string

Shift + Return to add a new line

Gradient end color in HEX format

gradient_type

string

Gradient type

Default: "linear"

gradient_rotation

integer

(minimum: 0, maximum: 360)

Gradient rotation angle in degrees (0 to 360)

Default: 0

text_box

string

Shift + Return to add a new line

Text bounding box in pixels (left, top, right, bottom)

show_text_box

boolean

Show text bounding box

Default: false

Run this model in Node.js with one line of code:

npx create-replicate --model=vetkastar/text_overlay

or set up a project from scratch

Install Replicate’s Node.js client library:

npm install replicate

Set the REPLICATE_API_TOKEN environment variable:

export REPLICATE_API_TOKEN=<paste-your-token-here>

Find your API token in your account settings.

Import and set up the client:

import Replicate from "replicate";

const replicate = new Replicate({
  auth: process.env.REPLICATE_API_TOKEN,
});

Run vetkastar/text_overlay using Replicate’s API. Check out the model's schema for an overview of inputs and outputs.

const output = await replicate.run(
  "vetkastar/text_overlay:64e04db571b1779137f169703f78f609f7be27a4e7b3f4e48b11ea889378a8bf",
  {
    input: {
      opacity: 100,
      padding: "10,10,10,10",
      font_size: 24,
      glow_size: 0,
      text_only: false,
      font_color: "#000000",
      font_style: "none",
      glow_color: "#FFFFFF",
      text_align: "left",
      shadow_color: "#000000",
      gradient_type: "linear",
      outline_color: "#000000",
      outline_width: 0,
      shadow_offset: 0,
      show_text_box: false,
      letter_spacing: 0,
      shadow_opacity: 100,
      rotation_slider: 0,
      gradient_rotation: 0
    }
  }
);

// To access the file URL:
console.log(output.url()); //=> "http://example.com"

// To write the file to disk:
fs.writeFile("my-image.png", output);

To learn more, take a look at the guide on getting started with Node.js.

Install Replicate’s Python client library:

pip install replicate

Set the REPLICATE_API_TOKEN environment variable:

export REPLICATE_API_TOKEN=<paste-your-token-here>

Find your API token in your account settings.

Import the client:

import replicate

Run vetkastar/text_overlay using Replicate’s API. Check out the model's schema for an overview of inputs and outputs.

output = replicate.run(
    "vetkastar/text_overlay:64e04db571b1779137f169703f78f609f7be27a4e7b3f4e48b11ea889378a8bf",
    input={
        "opacity": 100,
        "padding": "10,10,10,10",
        "font_size": 24,
        "glow_size": 0,
        "text_only": False,
        "font_color": "#000000",
        "font_style": "none",
        "glow_color": "#FFFFFF",
        "text_align": "left",
        "shadow_color": "#000000",
        "gradient_type": "linear",
        "outline_color": "#000000",
        "outline_width": 0,
        "shadow_offset": 0,
        "show_text_box": False,
        "letter_spacing": 0,
        "shadow_opacity": 100,
        "rotation_slider": 0,
        "gradient_rotation": 0
    }
)
print(output)

To learn more, take a look at the guide on getting started with Python.

Set the REPLICATE_API_TOKEN environment variable:

export REPLICATE_API_TOKEN=<paste-your-token-here>

Find your API token in your account settings.

Run vetkastar/text_overlay using Replicate’s API. Check out the model's schema for an overview of inputs and outputs.

curl -s -X POST \
  -H "Authorization: Bearer $REPLICATE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Prefer: wait" \
  -d $'{
    "version": "vetkastar/text_overlay:64e04db571b1779137f169703f78f609f7be27a4e7b3f4e48b11ea889378a8bf",
    "input": {
      "opacity": 100,
      "padding": "10,10,10,10",
      "font_size": 24,
      "glow_size": 0,
      "text_only": false,
      "font_color": "#000000",
      "font_style": "none",
      "glow_color": "#FFFFFF",
      "text_align": "left",
      "shadow_color": "#000000",
      "gradient_type": "linear",
      "outline_color": "#000000",
      "outline_width": 0,
      "shadow_offset": 0,
      "show_text_box": false,
      "letter_spacing": 0,
      "shadow_opacity": 100,
      "rotation_slider": 0,
      "gradient_rotation": 0
    }
  }' \
  https://api.replicate.com/v1/predictions

To learn more, take a look at Replicate’s HTTP API reference docs.

Output

No output yet! Press "Submit" to start a prediction.

Run time and cost

This model costs approximately $0.00027 to run on Replicate, or 3703 runs per $1, but this varies depending on your inputs. It is also open source and you can run it on your own computer with Docker.

This model runs on CPU hardware. Predictions typically complete within 3 seconds.

Readme

This model doesn't have a readme.