erbridge/mascot-me | API reference

Forked from corywilkerson/mascot-me

Public

91 runs

Run erbridge/mascot-me 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
input_image	string		A clear photo of the person whose facial features will be transformed into the mascot. Best results with well-lit front-facing photos showing the full face.
mascot_style	None	sports team mascot	The type of mascot character to create. Each style determines the setting, props, and overall aesthetic of the final mascot.
team_colors	string	blue and white	The main colors to use for the mascot's costume and accessories. These will be the dominant colors in the final image (e.g., 'red and blue', 'green and gold', 'purple and silver').
mascot_name	string		Give your mascot a name to help shape its personality and character traits. Names like 'Thunder' create bold mascots, while 'Buddy' creates friendly ones. Leave blank for a generic mascot.
seed	integer		A number that controls the randomness of image generation. Use the same seed to get identical results, or leave empty to generate a unique mascot each time.

{
  "type": "object",
  "title": "Input",
  "required": [
    "input_image"
  ],
  "properties": {
    "seed": {
      "type": "integer",
      "title": "Seed",
      "x-order": 4,
      "nullable": true,
      "description": "A number that controls the randomness of image generation. Use the same seed to get identical results, or leave empty to generate a unique mascot each time."
    },
    "input_image": {
      "type": "string",
      "title": "Input Image",
      "format": "uri",
      "x-order": 0,
      "description": "A clear photo of the person whose facial features will be transformed into the mascot. Best results with well-lit front-facing photos showing the full face."
    },
    "mascot_name": {
      "type": "string",
      "title": "Mascot Name",
      "default": "",
      "x-order": 3,
      "description": "Give your mascot a name to help shape its personality and character traits. Names like 'Thunder' create bold mascots, while 'Buddy' creates friendly ones. Leave blank for a generic mascot."
    },
    "team_colors": {
      "type": "string",
      "title": "Team Colors",
      "default": "blue and white",
      "x-order": 2,
      "description": "The main colors to use for the mascot's costume and accessories. These will be the dominant colors in the final image (e.g., 'red and blue', 'green and gold', 'purple and silver')."
    },
    "mascot_style": {
      "enum": [
        "sports team mascot",
        "university mascot",
        "cartoon character",
        "superhero mascot",
        "animal mascot",
        "retro cartoon",
        "modern cartoon",
        "pixel art character"
      ],
      "type": "string",
      "title": "mascot_style",
      "description": "The type of mascot character to create. Each style determines the setting, props, and overall aesthetic of the final mascot.",
      "default": "sports team mascot",
      "x-order": 1
    }
  }
}

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"
}

Example API response

View prediction

'https://replicate.delivery/xezq/mUaL7uvQ16bhFp3RzlbeaivTDBZPYU4fC8EmUduWubKoZQLVA/tmpp8xstrkg.png'