resourcepack.ai
DOCS

Jobs

Check a generation

A handle looks like <pack>:<kind>:<name> and comes back from every generation endpoint. A pack import's is <pack>:import, and its answer carries import (what came in, what didn't and why) where a generation's carries asset.

Shaders, VFX and emotes keep stores of their own, and an AI edit is a run on an asset that already exists, so their handles name that instead of a file format (<pack>:shader:<id>, <pack>:vfx:<id>, <pack>:emote:<id>, <pack>:emote_group:<id>, <pack>:edit:<key>) and their answers carry no asset. An edit's job reads ready once the edit has been saved.

A skin has no pack, so its handle is skin:<id>, its pack is null and its answer carries skin.

There's no jobs table behind this: generation is two-phase, so the asset row is written up front with status generating and the runner fills it in. The asset is the job record, which is why a handle stays resolvable long after the run finished.

Polling always terminates. A run that dies without recording anything reads as error once it passes the stale cutoff.

GET/jobs/{job}

Path parameters

jobstringrequired

The job handle.

Response · 200

The job's current state. status is generating, ready or error.

jobstringrequired

The handle you asked about.

packstringrequired

The pack it belongs to. Null for a skin.

statusstringrequired

Hoisted from the asset so a poll loop needn't reach into it.

Options: generating, ready, error

errorstring

Why it failed. Null unless status is error.

assetobject

The asset itself. Absent for an import, a shader, a VFX, an emote, an edit and a skin.

idstringrequired

Stable id, and the job handle this asset was created under.

typestringrequired

What the asset is. Read this to tell assets apart.

Options: model, vehicle, mob, block, block_face, model_texture, item, item_model, item3d, armor, armor3d, gui, hud, dialog, icon, rank_tag, sound, shader, text_effect, vfx, emote, emote_group

kindstringrequired

The file format it is stored as, which several types share. For a shader, text effect, VFX, emote or emote group, the store it lives in instead: those are documents rather than stored files.

Options: texture, model, font, sound, shader, vfx, emote, emote_group

namestringrequired

Its stored name within the pack. Treat it as an opaque key: type says what the asset is.

statusstringrequired

Where the generation got to.

Options: generating, ready, error

displayNamestring

The label you gave it, if any.

promptstring

What it was generated from.

errorstring

Why it failed. Null unless status is error.

sizeBytesinteger

Size of the stored file. Null for the kinds with no file.

updatedAtstringrequired

ISO 8601.

skinobject

For a skin: the skin itself.

idstringrequired

The skin's id.

namestringrequired

Its name.

variantstringrequired

Arm width: wide (Steve) or slim (Alex).

Options: wide, slim

statusstringrequired

Where its generation got to. A skin made in the Studio is ready.

Options: generating, ready, error

errorstringrequired

Why the generation failed. Null otherwise.

promptstringrequired

What it was generated from, if it was.

createdAtstringrequired

ISO 8601.

updatedAtstringrequired

ISO 8601.

jobstringrequired

Its job handle, skin:<id>.

importobject

For an import: the report, once it has finished — written and planned per kind, skipped by reason, failures, missingRefs, warnings, and stopped if a plan limit ended it early. Null while it runs.

Error codes

Branch on error.code, never on the message.

invalid_job_handle400

A job handle that isn't <pack>:<kind>:<name> or <pack>:import.

invalid_api_key401

The key isn't one of ours, or it has been revoked.

missing_api_key401

No Authorization: Bearer header was sent.

wrong_key_kind401

An MCP key sent to the REST API, or an API key sent to the MCP server. Each only opens its own.

account_suspended403

The account is suspended, so its keys open nothing. message says until when, if the suspension has an end date.

plan_required403

The key is valid, but its account's plan does not include the API.

job_not_found404

No job by that handle.

not_found404

No such pack, asset or job.