Build from your own code: API keys and batch builds

Make an API key

1. 1

   Open Settings, API keys.

2. 2

   Type a name and press Create key. The key is shown once with Copy; save it, then press "I've saved my key".

3. 3

   You can hold up to 5 keys. Revoke stops a key at once.

Keep keys on your server, never in a web page or a game client.

Generation API (one build)

Origin https://api.myrlin.io, key in the X-API-Key header.

1. 1

   GET /v1/balance: your balance and cost_per_generation (15).

2. 2

   POST /v1/generate with a JSON body: prompt (3 to 500 characters), workflow (text_to_3d, or image_to_3d with reference_image_base64, a PNG, JPEG or WebP), style hytale, output_format blockymodel or both. Keep the returned id.

3. 3

   Poll GET /v1/generations/{id} with backoff until the status is complete or failed. Then download blockymodel_url, texture_url and thumbnail_url (signed for 24 hours).

4. 4

   GET /v1/usage and GET /v1/usage/stats show this key's requests.

The API builds Hytale models. For Minecraft, build in Create and choose the Minecraft download. Full reference: forge.myrlin.io/docs/api.

Batch builds (pipeline API)

Batches run under https://api.myrlin.io/api/pipeline/v1: you send a manifest (the files you want), get a quote, approve it, and download one ZIP with a result.json. Creator runs 3 batches at once, Pro 8, Max 20; a Free account can read, quote and lint but not start a batch.

A batch needs a pipeline key (a key with pipeline permissions). A plain key from the form above is refused with 403 no_pipeline_grant. Make a pipeline key like this:

1. 1

   Open Settings, API keys, and find the Pipeline keys panel under the plain key form.

2. 2

   Press New pipeline key and pick a preset: Mod Works (everything, for one project), Read only (look at projects, batches and results), Submit only (upload, check, price and submit, then read results; for a build job), or Custom (pick each permission; choose this if your script must also create projects).

3. 3

   Optional: bind it to one project, set the credit limits (Blank means 0: free work only; set a daily and a per-batch limit to run priced work), an expiry and the addresses it may be used from.

4. 4

   Create it. The key is shown once; copy it. You can rotate a key (the old one keeps working for 24 hours), change its limits, read its audit trail, or revoke it in the same panel.

The batch guide is at forge.myrlin.io/docs/pipeline: a five-step quickstart from a key to a ZIP, the manifest format, the batch lifecycle, polling, errors, examples in curl and Python, plans and limits, pricing per lane, and the full route reference.

(opens the full picture in a new tab)