GET /custom_faces/{base_emoji}
Use this endpoint to combine face Twemojis using one as a base.
Arguments
Name | Required | Type | Default |
---|---|---|---|
base_emoji | ✅ | String (emoji) | none |
head | ❌ | Strings (comma separated emojis) | base emoji |
cheeks | ❌ | Strings (comma separated emojis) | base emoji |
mouth | ❌ | Strings (comma separated emojis) | base emoji |
nose | ❌ | Strings (comma separated emojis) | base emoji |
eyes | ❌ | Strings (comma separated emojis) | base emoji |
eyewear | ❌ | Strings (comma separated emojis) | base emoji |
headwear | ❌ | Strings (comma separated emojis) | base emoji |
other | ❌ | Strings (comma separated emojis) | base emoji |
Other arguments are available to all /custom_faces
endpoints.
Facial Features
Facial feature are passed in as keys with comma separated emojis as their values. When multiple emojis are provided, the first is at the bottom. More information on this can be found in the Stacking Order section.
Building a Request
Idea for a face:
Request:
1/v1/custom_faces/1f47f?eyes=1f644,263a&mouth=2639&eyewear=1f978
Any feature not specified will receive the feature from the base_emoji
. To remove a base_emoji
feature without replacing it from another emoji, pass in nothing or false
.
1# Head empty, no thoughts
2/v1/custom_faces/1f47f?head=&eyes=1f644,263a&mouth=2639&eyewear=1f978
3
4# Head false, headless horseman
5/v1/custom_faces/1f47f?head=false&eyes=1f644,263a&mouth=2639&eyewear=1f978
To move eyes
above eyewear
, pass in order=manual
and move eyes
after eyewear
.
1/v1/custom_faces/1f47f?head=false&mouth=2639&eyewear=1f978&eyes=1f644,263a&order=manual
Example
Request:
CUSTOM_TWEMOJI_API=https://customtwemojiapi.com/v1; curl $CUSTOM_TWEMOJI_API/custom_faces/1f47f?eyes=263a&mouth=2639&eyewear=1f978
Response:
1{
2 ...
3 "data": "<svg xmlns=\"http://www.w3.org/2000/svg\" height=\"100%\" width=\"100%\">\n <rect width=\"100%\" height=\"100%\" fill=\"\"/>\n <svg xmlns=\"http://www.w3.org/2000/svg\" id=\"emoji\" height=\"100% - 0px\" width=\"100% - 0px\" x=\"0px\" y=\"0px\" viewBox=\"0 0 36 36\">\n <circle fill=\"#AA8DD8\" cx=\"18\" cy=\"18\" r=\"18\" id=\"1f47f-head-0\" class=\"1f47f head\"/><path fill=\"#AA8DD8\" d=\"M10 4C7.42 4 4.369 1.534 3.414 0.586 2.843 0.014 1.981-0.157 1.235 0.153 0.487 0.462 0 1.191 0 2 0 5.459 1.672 12 8 12 8.757 12 9.45 11.572 9.789 10.894L11.789 6.894C12.099 6.274 12.065999999999999 5.538 11.701 4.948 11.337 4.359 10.693 4 10 4Z\" id=\"1f47f-head-1\" class=\"1f47f head\"/><path fill=\"#AA8DD8\" d=\"M34.766 0.153C34.016-0.158 33.159 0.013999999999999985 32.586 0.587 31.7 1.472 28.589 4 26 4 25.307 4 24.663 4.359 24.299 4.949 23.935 5.538 23.902 6.275 24.211 6.895L26.211 10.895C26.55 11.572 27.242 12 28 12 34.328 12 36 5.459 36 2 36 1.1909999999999998 35.513 0.46199999999999997 34.766 0.15300000000000002Z\" id=\"1f47f-head-2\" class=\"1f47f head\"/><path fill=\"#664500\" d=\"M8.665 27.871C8.843 28.032 9.109 28.041999999999998 9.299999999999999 27.9 9.338999999999999 27.871 13.222 25 18 25 22.766 25 26.662 27.871 26.7 27.9 26.891 28.041999999999998 27.157 28.029999999999998 27.335 27.871 27.512 27.711 27.552 27.447 27.429000000000002 27.243 27.3 27.029 24.212 22 18 22S8.699 27.028 8.571 27.243000000000002C8.448 27.448 8.487 27.711000000000002 8.665 27.871000000000002Z\" id=\"2639-mouth-3\" class=\"2639 mouth\"/><path fill=\"#664500\" d=\"M29 14C28.744 14 28.488 13.902 28.293 13.707 25.716 11.132000000000001 21.238 11.971 21.194 11.981000000000002 20.646 12.090000000000002 20.127 11.734000000000002 20.02 11.194 19.913 10.653 20.262 10.128 20.803 10.020000000000001 21.03 9.974000000000002 26.366 8.955000000000002 29.706000000000003 12.293000000000001 30.097 12.684000000000001 30.097 13.316 29.706000000000003 13.707 29.512000000000004 13.902000000000001 29.256000000000004 14 29.000000000000004 14Z\" id=\"263a-eyes-3\" class=\"263a eyes\"/><path fill=\"#664500\" d=\"M7 14C6.744 14 6.4879999999999995 13.902 6.293 13.707 5.902 13.316 5.902 12.684000000000001 6.293 12.293000000000001 9.633 8.952000000000002 14.971 9.975000000000001 15.196000000000002 10.020000000000001 15.738000000000001 10.128000000000002 16.089000000000002 10.655000000000001 15.980000000000002 11.197000000000001 15.872000000000002 11.737000000000002 15.347000000000001 12.089 14.805000000000001 11.982000000000001 14.736 11.967 10.276000000000002 11.139000000000001 7.707000000000002 13.708000000000002 7.512000000000001 13.902000000000003 7.256000000000002 14.000000000000002 7.000000000000002 14.000000000000002Z\" id=\"263a-eyes-4\" class=\"263a eyes\"/><path fill=\"#664500\" d=\"M26 19C25.744 19 25.488 18.902 25.293 18.707 23.989 17.402 21.203 17.733 20.241 17.971 19.701 18.103 19.164 17.776 19.03 17.241 18.897000000000002 16.705 19.222 16.164 19.758000000000003 16.03 19.944000000000003 15.984000000000002 24.333000000000002 14.919 26.707 17.293 27.098 17.683999999999997 27.098 18.316 26.707 18.707 26.512 18.902 26.256 19 26 19Z\" id=\"263a-eyes-5\" class=\"263a eyes\"/><path fill=\"#664500\" d=\"M10 19C9.744 19 9.488 18.902 9.293 18.707 8.902 18.316000000000003 8.902 17.684 9.293 17.293 11.666 14.919999999999998 16.057 15.984 16.243 16.03 16.778 16.164 17.102999999999998 16.705000000000002 16.97 17.241 16.837999999999997 17.777 16.296999999999997 18.104 15.759999999999998 17.971 14.795999999999998 17.734 12.010999999999997 17.404 10.707999999999998 18.707 10.511999999999999 18.902 10.255999999999998 19 9.999999999999998 19Z\" id=\"263a-eyes-6\" class=\"263a eyes\"/><path fill=\"#292F33\" d=\"M34.808 9.627C34.637 9.461 33.541 9.901 32.432 9.336 30.144000000000002 8.17 24.362000000000002 7.045 20.598000000000003 9.712 20.195000000000004 9.997 18.511000000000003 10.045 18.040000000000003 10.025 17.569000000000003 10.046000000000001 15.885000000000003 9.998000000000001 15.482000000000003 9.712 11.719000000000003 7.045 5.937000000000003 8.17 3.6490000000000027 9.336 2.5400000000000027 9.901 1.4440000000000026 9.461 1.2730000000000028 9.627 1.026000000000003 9.866000000000001 1.026000000000003 10.823 1.2740000000000027 11.063 1.5200000000000027 11.302000000000001 2.751000000000003 11.578000000000001 2.9960000000000027 12.295 3.2430000000000025 13.013 3.2450000000000028 17.253 5.209000000000003 18.719 7.048000000000004 20.091 11.338000000000003 20.504 14.057000000000004 18.957 16.429000000000002 17.608 16.346000000000004 14.768 16.781000000000006 13.076 16.936000000000007 12.473 17.373000000000005 12.169 18.041000000000007 12.169S19.146000000000008 12.473 19.30100000000001 13.076C19.736000000000008 14.767000000000001 19.652000000000008 17.608 22.02500000000001 18.957 24.74400000000001 20.503 29.03400000000001 20.09 30.872000000000007 18.719 32.83700000000001 17.254 32.839000000000006 13.013000000000002 33.08500000000001 12.295000000000002 33.330000000000005 11.578000000000001 34.56100000000001 11.301000000000002 34.80700000000001 11.063000000000002 35.05500000000001 10.823000000000002 35.05600000000001 9.866000000000003 34.80800000000001 9.627000000000002Z M14.614 13.277000000000001C14.537 14.382000000000001 14.34 16.504 13.017000000000001 17.257 12.206000000000001 17.719 11.149000000000001 18 10.043000000000001 18H10.042000000000002C8.817000000000002 18 7.1190000000000015 17.653 6.455000000000002 17.158 5.625000000000002 16.539 5.309000000000002 13.991000000000001 5.190000000000002 13.038 5.1140000000000025 12.431000000000001 4.910000000000002 10.948 5.578000000000002 10.72 6.638000000000002 10.359 8.117000000000003 10.077 9.630000000000003 10.077 10.323000000000002 10.077 12.651000000000003 10.12 13.785000000000004 10.818 14.790000000000003 11.434999999999999 14.657000000000004 12.669 14.614000000000004 13.277Z M30.892 13.024000000000001C30.773 13.978000000000002 30.457 16.539 29.627 17.158 28.962999999999997 17.653000000000002 27.265 18 26.04 18H26.038999999999998C24.932 18 23.875999999999998 17.719 23.063999999999997 17.257 21.740999999999996 16.505000000000003 21.543999999999997 14.396 21.466999999999995 13.291 21.424999999999994 12.683 21.290999999999997 11.440000000000001 22.295999999999996 10.823 23.430999999999997 10.125 25.757999999999996 10.077 26.450999999999997 10.077 27.964 10.077 29.441999999999997 10.354 30.502999999999997 10.715 31.170999999999996 10.943 30.967999999999996 12.417 30.891999999999996 13.024000000000001Z\" id=\"1f978-eyewear-9\" class=\"1f978 eyewear\"/><path fill=\"#292F33\" d=\"M14.337 10.19S14.277 6.975999999999999 13.027 5.9639999999999995C11.710999999999999 4.898999999999999 10.645999999999999 6.558999999999999 10.645999999999999 6.558999999999999S10.393999999999998 4.4159999999999995 8.966 4.594999999999999C7.537999999999999 4.773999999999999 7.5969999999999995 6.142999999999999 7.5969999999999995 6.142999999999999S6.776999999999999 4.297999999999999 5.215999999999999 4.952999999999999C3.6979999999999995 5.59 4.4559999999999995 6.976999999999999 4.4559999999999995 6.976999999999999S3.3109999999999995 6.566999999999999 2.7899999999999996 7.393C2.0749999999999997 8.524 3.7879999999999994 9.417 3.7879999999999994 9.417S7.359 8.584 9.145 8.643C10.931 8.702 14.337 10.190000000000001 14.337 10.190000000000001Z\" id=\"1f978-eyewear-12\" class=\"1f978 eyewear\"/><path fill=\"#292F33\" d=\"M21.663 10.19S21.723 6.975999999999999 22.973 5.9639999999999995C24.288999999999998 4.898999999999999 25.354 6.558999999999999 25.354 6.558999999999999S25.605999999999998 4.4159999999999995 27.034 4.594999999999999C28.462999999999997 4.773999999999999 28.403 6.142999999999999 28.403 6.142999999999999S29.223 4.297999999999999 30.784 4.952999999999999C32.302 5.59 31.544 6.976999999999999 31.544 6.976999999999999S32.689 6.568 33.211 7.393999999999999C33.925 8.524999999999999 32.213 9.418 32.213 9.418S28.642 8.584999999999999 26.856 8.643999999999998C25.069000000000003 8.701999999999998 21.663000000000004 10.189999999999998 21.663000000000004 10.189999999999998Z\" id=\"1f978-eyewear-13\" class=\"1f978 eyewear\"/></svg>\n</svg>",
4 ...
5}