Get Job Status

GET 
/v2/queue/:jobId

Get the status of a generator job.

This endpoint is rate limited per job. it's recommended you check on the status of a generator job once every second, at most.

Request

Path Parameters

jobId uuidrequired

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

Responses

200

Job Completed

application/json

Schema

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

Example (from schema)

{
  "job": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "unknown",
    "result": "string"
  },
  "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

success booleanrequired
Example: false

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

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

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

success booleanrequired
Example: false

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

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

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

success booleanrequired
Example: false

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

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

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

Loading...