Generate a skin

POST 
/v2/generate

Note: this endpoint is not recommended. You should use the queue endpoints instead to submit jobs and check on their status periodically.

Queue skin generation and wait for the result.

Request

Header Parameters

User-Agent stringrequired
Custom User-Agent for your application, see user-agent.dev for implementation examples. Alternatively you can also use the 'MineSkin-User-Agent' header.
Example: ExampleApp/v1.0
Authorization string
API key from account.mineskin.org
Example: Bearer da84de82e960d6c0510088279878c79365ad5118d350d619f20324a5494f156b

application/json

Body

required

oneOf

UrlGenerateBody

URL Generate Request Body

variantSkinVariant (string)

Possible values: [classic, slim, unknown]

Default value: unknown

namestring

Possible values: <= 20 characters

visibilitySkinVisibility (string)

Possible values: [public, unlisted, private]

Default value: public

capeuuid

[EXPERIMENTAL] Cape UUID to apply to this skin

Currently supported:

• 15th Anniversary ef9e95b6-48a3-4fd7-93d4-7e7d9448d2f1
• Migrator 5af20372-79e0-4e1f-80f8-6bd8e3135995
• Vanilla 7412868d-7be3-429f-b629-ed5074d2455c

urlstringrequired

UserGenerateBody

User Generate Request Body

variantSkinVariant (string)

Possible values: [classic, slim, unknown]

Default value: unknown

namestring

Possible values: <= 20 characters

visibilitySkinVisibility (string)

Possible values: [public, unlisted, private]

Default value: public

capeuuid

[EXPERIMENTAL] Cape UUID to apply to this skin

Currently supported:

• 15th Anniversary ef9e95b6-48a3-4fd7-93d4-7e7d9448d2f1
• Migrator 5af20372-79e0-4e1f-80f8-6bd8e3135995
• Vanilla 7412868d-7be3-429f-b629-ed5074d2455c

userstringrequired

Player UUID

Possible values: >= 32 characters and <= 36 characters

multipart/form-data

Body

required

oneOf

UploadGenerateBody

File Upload Generate Request Body

variantSkinVariant (string)

Possible values: [classic, slim, unknown]

Default value: unknown

namestring

Possible values: <= 20 characters

visibilitySkinVisibility (string)

Possible values: [public, unlisted, private]

Default value: public

capeuuid

[EXPERIMENTAL] Cape UUID to apply to this skin

Currently supported:

• 15th Anniversary ef9e95b6-48a3-4fd7-93d4-7e7d9448d2f1
• Migrator 5af20372-79e0-4e1f-80f8-6bd8e3135995
• Vanilla 7412868d-7be3-429f-b629-ed5074d2455c

filebinaryrequired

PNG image file to upload. You should use a client library like MineSkin Java Client to properly handle file uploads. See github/examples

UrlGenerateBody

URL Generate Request Body

variantSkinVariant (string)

Possible values: [classic, slim, unknown]

Default value: unknown

namestring

Possible values: <= 20 characters

visibilitySkinVisibility (string)

Possible values: [public, unlisted, private]

Default value: public

capeuuid

[EXPERIMENTAL] Cape UUID to apply to this skin

Currently supported:

• 15th Anniversary ef9e95b6-48a3-4fd7-93d4-7e7d9448d2f1
• Migrator 5af20372-79e0-4e1f-80f8-6bd8e3135995
• Vanilla 7412868d-7be3-429f-b629-ed5074d2455c

urlstringrequired

UserGenerateBody

User Generate Request Body

variantSkinVariant (string)

Possible values: [classic, slim, unknown]

Default value: unknown

namestring

Possible values: <= 20 characters

visibilitySkinVisibility (string)

Possible values: [public, unlisted, private]

Default value: public

capeuuid

[EXPERIMENTAL] Cape UUID to apply to this skin

Currently supported:

• 15th Anniversary ef9e95b6-48a3-4fd7-93d4-7e7d9448d2f1
• Migrator 5af20372-79e0-4e1f-80f8-6bd8e3135995
• Vanilla 7412868d-7be3-429f-b629-ed5074d2455c

userstringrequired

Player UUID

Possible values: >= 32 characters and <= 36 characters

Responses

200

Generator Success

application/json

Schema

Schema

skin

object

required

uuidstringrequired

namestring

visibilitySkinVisibility (string)required

Possible values: [public, unlisted, private]

Default value: public

variantSkinVariant (string)required

Possible values: [classic, slim, unknown]

Default value: unknown

texture

object

required

data

object

required

valuestringrequired

Skin Value

signaturestringrequired

Skin Signature

hash

object

required

skinstringrequired

Skin Hash

capestring

(optional) Cape Hash

url

object

required

skinstringrequired

Skin Texture Url

capestring

(optional) Cape Texture Url

generator

object

required

versionstringrequired

timestampnumberrequired

durationnumberrequired

accountstringrequired

serverstringrequired

viewsnumberrequired

duplicatebooleanrequired

rateLimit

object

next

object

required

absolutetimestamprequired

Absolute timestamp (in milliseconds) after which the next request can be made

Example: 1726829503123

relativenumberrequired

Relative delay (in milliseconds) after which the next request can be made

Example: 800

delay

object

required

millisnumberrequired

Delay between requests (in milliseconds) - depends on the API key used for this request

Example: 1200

secondsnumber

Delay between requests (in seconds) - depends on the API key used for this request

Example: 1.2

limit

object

limitnumberrequired

Limit of requests in the current window (usually 1 minute). Same as the 'X-RateLimit-Limit' header

Example: 60

remainingnumberrequired

Remaining requests in the current window. Same as the 'X-RateLimit-Remaining' header

Example: 58

usage

object

credits

object

usednumberrequired

Credits used for this request

Example: 1

remainingnumberrequired

Remaining credits

Example: 23

metered

object

usednumberrequired

Number of metered units used for this request

Example: 1
successbooleanrequired
Example: true

errors

object[]

Array [

codestring

messagestring

]

warnings

object[]

Array [

codestring

messagestring

]

messages

object[]

Array [

codestring

messagestring

]

links

object

Links to related resources

selfstring

Example (from schema)

{
  "skin": {
    "uuid": "c891dfac4cd247a2a55743e7e82ce76f",
    "name": "Test Skin",
    "visibility": "public",
    "variant": "classic",
    "views": 1,
    "duplicate": false
  },
  "rateLimit": {
    "next": {
      "absolute": 1726829503123,
      "relative": 800
    },
    "delay": {
      "millis": 1200,
      "seconds": 1.2
    },
    "limit": {
      "limit": 60,
      "remaining": 58
    }
  },
  "usage": {
    "credits": {
      "used": 1,
      "remaining": 23
    },
    "metered": {
      "used": 1
    }
  },
  "success": true,
  "errors": [],
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "messages": [
    {
      "code": "ok",
      "message": "All good!"
    }
  ],
  "links": {
    "self": "string"
  }
}

400

Bad Request

application/json

Schema

Schema

successbooleanrequired
Example: false

errors

object[]

Array [

codestring

messagestring

]

warnings

object[]

Array [

codestring

messagestring

]

messages

object[]

Array [

codestring

messagestring

]

links

object

Links to related resources

selfstring

rateLimit

object

next

object

required

absolutetimestamprequired

Absolute timestamp (in milliseconds) after which the next request can be made

Example: 1726829503123

relativenumberrequired

Relative delay (in milliseconds) after which the next request can be made

Example: 800

delay

object

required

millisnumberrequired

Delay between requests (in milliseconds) - depends on the API key used for this request

Example: 1200

secondsnumber

Delay between requests (in seconds) - depends on the API key used for this request

Example: 1.2

limit

object

limitnumberrequired

Limit of requests in the current window (usually 1 minute). Same as the 'X-RateLimit-Limit' header

Example: 60

remainingnumberrequired

Remaining requests in the current window. Same as the 'X-RateLimit-Remaining' header

Example: 58

Example (from schema)

{
  "success": false,
  "errors": [
    {
      "code": "generic_error",
      "message": "Something went wrong"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "messages": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": {
    "self": "string"
  },
  "rateLimit": {
    "next": {
      "absolute": 1726829503123,
      "relative": 800
    },
    "delay": {
      "millis": 1200,
      "seconds": 1.2
    },
    "limit": {
      "limit": 60,
      "remaining": 58
    }
  }
}

429

Rate Limited

application/json

Schema

Schema

successbooleanrequired
Example: false

errors

object[]

Array [

codestring

messagestring

]

warnings

object[]

Array [

codestring

messagestring

]

messages

object[]

Array [

codestring

messagestring

]

links

object

Links to related resources

selfstring

rateLimit

object

next

object

required

absolutetimestamprequired

Absolute timestamp (in milliseconds) after which the next request can be made

Example: 1726829503123

relativenumberrequired

Relative delay (in milliseconds) after which the next request can be made

Example: 800

delay

object

required

millisnumberrequired

Delay between requests (in milliseconds) - depends on the API key used for this request

Example: 1200

secondsnumber

Delay between requests (in seconds) - depends on the API key used for this request

Example: 1.2

limit

object

limitnumberrequired

Limit of requests in the current window (usually 1 minute). Same as the 'X-RateLimit-Limit' header

Example: 60

remainingnumberrequired

Remaining requests in the current window. Same as the 'X-RateLimit-Remaining' header

Example: 58

Example (from schema)

{
  "success": false,
  "errors": [
    {
      "code": "generic_error",
      "message": "Something went wrong"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "messages": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": {
    "self": "string"
  },
  "rateLimit": {
    "next": {
      "absolute": 1726829503123,
      "relative": 800
    },
    "delay": {
      "millis": 1200,
      "seconds": 1.2
    },
    "limit": {
      "limit": 60,
      "remaining": 58
    }
  }
}

500

Generator Error

application/json

Schema

Schema

successbooleanrequired
Example: false

errors

object[]

Array [

codestring

messagestring

]

warnings

object[]

Array [

codestring

messagestring

]

messages

object[]

Array [

codestring

messagestring

]

links

object

Links to related resources

selfstring

rateLimit

object

next

object

required

absolutetimestamprequired

Absolute timestamp (in milliseconds) after which the next request can be made

Example: 1726829503123

relativenumberrequired

Relative delay (in milliseconds) after which the next request can be made

Example: 800

delay

object

required

millisnumberrequired

Delay between requests (in milliseconds) - depends on the API key used for this request

Example: 1200

secondsnumber

Delay between requests (in seconds) - depends on the API key used for this request

Example: 1.2

limit

object

limitnumberrequired

Limit of requests in the current window (usually 1 minute). Same as the 'X-RateLimit-Limit' header

Example: 60

remainingnumberrequired

Remaining requests in the current window. Same as the 'X-RateLimit-Remaining' header

Example: 58

Example (from schema)

{
  "success": false,
  "errors": [
    {
      "code": "generic_error",
      "message": "Something went wrong"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "messages": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": {
    "self": "string"
  },
  "rateLimit": {
    "next": {
      "absolute": 1726829503123,
      "relative": 800
    },
    "delay": {
      "millis": 1200,
      "seconds": 1.2
    },
    "limit": {
      "limit": 60,
      "remaining": 58
    }
  }
}