This API is used to generate RGB gradient text for Minecraft and is based on JSON. Useful for creating gradient text in your own code for anything Minecraft-related. The API has default values that are the same as the RGBirdflop website, which are also shown in the docs below. To generate a gradient, make a GET request to /api/v2/rgb. The API will return a JSON object with the gradient output.
POST: Generate a gradient.
GET: Equivalent to POST, but with query parameters.
text
type: string
The text to use for the gradient.
default: "birdflop"
colors
type: array of (Color object - see data models in docs) or array of (string)
The colors to use for the gradient. Must be in hex format.
default: [ { "hex": "#084CFB", "pos": 0 }, { "hex": "#ADF3FD", "pos": 100 } ]
format
type: Format object - see data models in docs
The format to use for the color and format codes. For MiniMessage, { color: "MiniMessage" } can be used.
default: { "color": "&#$1$2$3$4$5$6$f$c", "char": "&" }
prefixsuffix
type: string
The prefix or suffix to use for the text. Usually used for commands and stuff. $t will be replaced with the output text, if $t is not included, the output will not show.
default: ""
trimspaces
type: boolean
Whether or not to trim color codes from spaces. Turn this off if you're using empty underlines or strikethroughs.
default: true
colorlength
type: number
The amount of characters for one color step.
default: 1
bold
type: boolean
Whether or not to bold the text.
default: false
italic
type: boolean
Whether or not to italicize the text.
default: false
underline
type: boolean
Whether or not to underline the text.
default: false
strikethrough
type: boolean
Whether or not to strikethrough the text.
default: false
silent
type: boolean
Set this to true to hide the options and input.
default: false
color
required
type: string
The format to use for the color codes. $1 = #(r)rggbb, $2 = #r(r)ggbb, $3 = #rr(g)gbb, $4 = #rrg(g)bb, $5 = #rrgg(b)b, $6 = #rrggb(b), $f = format tags, $c = the character
example: "&#$1$2$3$4$5$6$f$c" or "MiniMessage"
char
type: string
The character to use for the format tags. (such as &l, &o, &n, &m)
example: "&"
bold
type: string
The code to use for making the text bold. $t is where the output text will go. If $t is not included, the output will not show.
example: <b>$t</b>
italic
type: string
The code to use for making the text italic. $t is where the output text will go. If $t is not included, the output will not show.
example: <i>$t</i>
underline
type: string
The code to use for making the text underline. $t is where the output text will go. If $t is not included, the output will not show.
example: <u>$t</u>
strikethrough
type: string
The code to use for making the text strikethrough. $t is where the output text will go. If $t is not included, the output will not show.
example: <s>$t</s>