API Documentation

Available male features

The features for the male avatar are optional — but required to generate the desired avatar outcome. Premium features requires a paid [tier] API key.

Default male features

The <default> male avatar feature(s) will be used for the ones not supplied. Please supply all the required features, in each API request, to generate the desired male avatar outcome.

The following avatar features are not generated unless explicitly supplied:

• glasses
• beard
• moustache
• goatee

Available male hair combinations Toggle Male Hair Combinations Table

You can generate any of the following male hair styles using the combinations below. For specific hair colors, use the hair_color feature (see above).

Showing the list of valid male hair combinations

Image	Combination
	hair_type: "spiky", hair_length: "high", hair_style: "regular_back"
	hair_type: "curly", hair_length: "long", hair_style: "afro_blow_out"
	hair_type: "wavy", hair_length: "long", hair_style: "blow_out"
	hair_type: "curly", hair_length: "short", hair_style: "afro_blow_out"
	hair_type: "straight", hair_length: "short", hair_style: "blow_out"
	hair_type: "straight", hair_length: "short", hair_style: "bowl_cut"
	hair_type: "straight", hair_length: "short", hair_style: "crew"
	hair_type: "shaggy", hair_length: "short", hair_style: "regular_back"
	hair_type: "spiky", hair_length: "short", hair_style: "regular_back"
	hair_type: "curly", hair_length: "short", hair_style: "regular_front"
	hair_type: "shaggy", hair_length: "short", hair_style: "regular_front"
	hair_type: "spiky", hair_length: "short", hair_style: "regular_front"
	hair_type: "straight", hair_length: "short", hair_style: "regular_front"
	hair_type: "wavy", hair_length: "short", hair_style: "regular_front"

Alternative male hair styles

The alt_hair_style feature will result in a male avatar with very little to no hair (based on selected option). When supplied, the following hair features will be ignored:

• hair_type
• hair_length
• hair_style

Example of a generated male avatar

Available female features

The features for the female avatar are optional — but required to generate the desired avatar outcome. Premium features requires a paid [tier] API key.

Default female features

The <default> female avatar feature(s) will be used for the ones not supplied. Please supply all the required features, in each API request, to generate the desired female avatar outcome.

The following avatar features are not generated unless explicitly supplied:

• glasses
• bangs

Available femlae hair combinations Toggle Female Hair Combinations Table

You can generate any of the following female hair styles using the combinations below. For specific hair colors, use the hair_color feature (see above).

Showing the list of valid female hair combinations

Image	Combination
	hair_type: "curly", hair_length: "hip", hair_style: "afro_blow_out"
	hair_type: "curly", hair_length: "shoulder", hair_style: "afro_blow_out"
	hair_type: "curly", hair_length: "shoulder", hair_style: "blow_out" , bangs: "true"
	hair_type: "curly", hair_length: "short", hair_style: "shaggy" , bangs: "true"
	hair_type: "straight", hair_length: "hip", hair_style: "blow_out"
	hair_type: "straight", hair_length: "hip", hair_style: "blow_out" , bangs: "true"
	hair_type: "straight", hair_length: "short", hair_style: "blow_out"
	hair_type: "straight", hair_length: "shoulder", hair_style: "blow_out"
	hair_type: "straight", hair_length: "shoulder", hair_style: "blow_out" , bangs: "true"
	hair_type: "straight", hair_length: "short", hair_style: "bob_cut" , bangs: "true"
	hair_type: "straight", hair_length: "shoulder", hair_style: "bob_cut" , bangs: "true"
	hair_type: "straight", hair_length: "short", hair_style: "pixie_cut" , bangs: "true"
	hair_type: "straight", hair_length: "hip", hair_style: "pony_tail"
	hair_type: "straight", hair_length: "short", hair_style: "pony_tail" , bangs: "true"
	hair_type: "wavy", hair_length: "shoulder", hair_style: "blow_out"
	hair_type: "wavy", hair_length: "hip", hair_style: "pony_tail" , bangs: "true"
	hair_type: "wavy", hair_length: "short", hair_style: "shaggy" , bangs: "true"

Alternative female hair styles

The alt_hair_style feature will result in a female avatar with very little to no hair (based on selected option). When supplied, the following hair features will be ignored:

• hair_type
• hair_length
• hair_style

Example of a generated female avatar

Available random features

The gender feature is required for the random avatar API. An avatar of the specified gender will be randomly generated. Premium features requires a paid [tier] API key.

Default random features

The <default> random avatar feature(s) are set to false. To ensure the inclusion of a given feature, set it to true in the API request. To allow for random inclusion of a given feature, set it to random.

The use_all_features feature will override all other use_* ones. Please also note that setting a feature to true for the incorrect gender will return an error.

It is easy to make requests to our API. The following examples will demonstrate how to do this using JavaScript and Python. However, the same approach can be used with most languages.

// JavaScript (jQuery) example
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://avatargen.io/api/generator/female",
  "method": "POST",
  "headers": {
      "content-type": "application/x-www-form-urlencoded",
      "cache-control": "no-cache",
      "apiKey": "MY_API_KEY"
  },
  "data": { // user chose female options
      "skin_tone": "light",
      "head_shape": "diamond",
      "hair_length": "short",
      "hair_type": "straight",
      "hair_style": "blow_out",
      "hair_color": "blond",
      "eye_color": "blue",
      "body_type": "generic"
  }
};

$.ajax(settings).done(function (response) {
  console.log(response.format); // >> "PNG"
  console.log(response.avatar); // >> "data:image/png;base64,somechars=="
  // $("img").attr("src", response.avatar);
});

# Python 3 (http.client)
import http.client
import json

data = { # user chose male options
  "skin_tone": "light",
  "head_shape": "diamond",
  "hair_length": "short",
  "hair_style": "afro_blow_out",
  "hair_type": "curly",
  "hair_color": "blond",
  "eye_color": "blue",
  "body_type": "generic"
}
payload = json.dumps(data)

headers = {
  "content-type": "application/json; charset=utf-8",
  "cache-control": "no-cache",
  "apiKey": "MY_API_KEY"
}

conn = http.client.HTTPSConnection("avatargen.io")
conn.request("POST", "/api/generator/male", payload, headers)
res = conn.getresponse()
data = res.read()

res = json.loads(data.decode("utf-8"))
print(res["format"]) # >> "PNG"
print(res["avatar"]) # >> "data:image/png;base64,somechars=="

AvatarGen.io assests are designed to work with our API service. The provided assets can be imported into your project and used programatically. Don't want to type the features and options by hand? Check out our asset repository.

They are open sourced (MIT) and currently in beta. Drastic changes are to be expected.

Get the assets | Usage | GitHub

We're into backlinks! If you're on our free tier, please support us by using one of the following HTML backlink code.

Text Backlink

Powered by <a href="https://avatargen.io/" title="Avatar Generator API">AvatarGen.io</a>

Image Backlink

<a href="https://avatargen.io/" title="Avatar Generator API"><img src="//cdn.avatargen.io/icons/AvatarGen_logo.png" width="250px" alt="AvatarGen.io Logo" border="0"></a>

Stay up to date with AvatarGen.io and reach out to the community with these helpful resources.

• Join the official AvatarGen.io forum
• Read and subscribe to the Official AvatarGen.io Blog