Generating

Design a Tooltip

Designs a Tooltip from words: the box shown when a player hovers an item. Describe the item or the button it is for and how it should feel (a legendary fire sword for a level 50 boss drop, the VIP rank in a store menu); the designer picks the blocks (a header, big numbers, stats, a coloured band, an ability card, a bar, sockets), the words, the numbers and the colours, then looks at it drawn and fixes what it sees. Finishes before it answers, so there is no job to wait on; see it with get_tooltip_picture. A pack holds up to 200. 5 credits, flat, given back if it fails.

POST/packs/{pack}/tooltips

Path parameters

packstringrequired

The pack's slug, as returned by the packs endpoints.

Body

promptstringrequiredmax 600 characters

What it is for, and how it should look.

namestringmax 50 characters

Your label. Absent uses the name the designer gives it.

Response · 201

Designed and saved.

packstringrequired

The pack.

statusstring

ready, when it was designed or changed by AI.

tooltipobjectrequired

The Tooltip, with spec and components.

idstringrequired

Its id in the pack.

namestringrequired

Its name.

itemstringrequired

The vanilla item the give command hands out. The Tooltip itself shows on any item carrying its components.

widthintegerrequired

Its width in GUI pixels.

heightintegerrequired

Its height in GUI pixels.

blocksintegerrequired

How many blocks it has.

updatedAtstringrequired

ISO 8601.

giveCommandstringrequired

A /give for the item wearing it, once the pack is on the client (Minecraft 1.21.5+). Over 256 characters it has to run from the console or a command block.

componentsobject

The same item components as JSON, for ItemsAdder, Nexo or any plugin that takes them. Absent from the listing.

specobject

The design itself: width, padding, gap, frame, theme (colours), item, glint and blocks, top to bottom. Send it back changed to update_tooltip. Absent from the listing.

Error codes

Branch on error.code, never on the message.

invalid_request400

Something in the body or query is wrong. message says what.

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.

insufficient_credits402

Not enough AI Credits to run this. Nothing was started or charged.

account_suspended403

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

asset_limit_reached403

The pack is at its asset limit.

forbidden403

Valid key, but not permitted to do this in this pack.

plan_required403

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

not_found404

No such pack, asset or job.