Skip to main content

Queue skin generation

POST 

/v2/queue

Add a generation request to the queue.

Generating a single skin usually takes around 2 seconds, but can take longer depending API load and the number of generator jobs ahead of you in the queue.

Use multipart/form-data to upload image files or application/json for url and user requests.

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
    Example: Bearer da84de82e960d6c0510088279878c79365ad5118d350d619f20324a5494f156b

Body

required

    oneOf

    URL Generate Request Body

    variant SkinVariant (string)

    Possible values: [classic, slim, unknown]

    Default value: unknown
    name string

    Possible values: <= 20 characters

    visibility SkinVisibility (string)

    Possible values: [public, unlisted, private]

    Default value: public
    url stringrequired

Responses

Job Completed

Schema

    job

    object

    required

    id uuidrequired

    Job ID

    status stringrequired

    Job status

    • unknown: The job status is unknown
    • waiting: The job is waiting to be processed
    • active: The job is currently being processed
    • failed: The job has failed. The root 'errors' array may contain more details
    • completed: The job has completed. The 'result' field will contain the job result

    Possible values: [unknown, waiting, active, failed, completed]

    result string

    If the job is finished, this will return the result of the job (e.g. the skin UUID)

    skin

    object

    required

    uuid stringrequired
    name string
    visibility SkinVisibility (string)required

    Possible values: [public, unlisted, private]

    Default value: public
    variant SkinVariant (string)required

    Possible values: [classic, slim, unknown]

    Default value: unknown

    texture

    object

    required

    data

    object

    required

    value stringrequired

    Skin Value

    signature stringrequired

    Skin Signature

    hash

    object

    required

    skin stringrequired

    Skin Hash

    cape string

    (optional) Cape Hash

    url

    object

    required

    skin stringrequired

    Skin Texture Url

    cape string

    (optional) Cape Texture Url

    generator

    object

    required

    version stringrequired
    timestamp numberrequired
    duration numberrequired
    account stringrequired
    server stringrequired
    views numberrequired
    duplicate booleanrequired

    rateLimit

    object

    next

    object

    required

    absolute timestamprequired

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

    Example: 1726829503123
    relative numberrequired

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

    Example: 800

    delay

    object

    required

    millis numberrequired

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

    Example: 1200
    seconds number

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

    Example: 1.2

    limit

    object

    limit numberrequired

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

    Example: 60
    remaining numberrequired

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

    Example: 58

    usage

    object

    credits

    object

    used numberrequired

    Credits used for this request

    Example: 1
    remaining numberrequired

    Remaining credits

    Example: 23

    metered

    object

    used numberrequired

    Number of metered units used for this request

    Example: 1
    success booleanrequired
    Example: true

    errors

    object[]

  • Array [

  • code string
    message string
  • ]

  • warnings

    object[]

  • Array [

  • code string
    message string
  • ]

  • messages

    object[]

  • Array [

  • code string
    message string
  • ]

  • links

    object

    Links to related resources

    self string
Loading...