Maps

BloxMaps API and Studio commands

Make maps without the website: from your own server or tools with an API key, or from Roblox Studio's command bar with one line. Both use the same credits as your account, and nothing is spent without your say-so.

What it costs#

Making a map counts toward your plan's maps a day, the same as on the website. Exporting it (getting the models into Studio) spends credits from your account by the map's size:

• The size that counts is the size the generator really made (a map can come out bigger than you asked; the export tells you, and the Studio command asks again).
• Exporting a map you exported before is free.
• An export that fails on our side gives its credits back.
• API exports always use credits (they don't use a plan's monthly exports). Buy credits on the pricing page.

Studio commands (the command bar)#

With the BloxMaps Cloud plugin installed and signed in (see Export a map to Roblox Studio), open View > Command Bar and run:

_G.BloxMaps:GenerateMap("a snowy village with a castle", { size = "medium" })

The BloxMaps panel opens with a confirm card: your prompt, what exporting it costs and your balance. Press Generate and the plugin makes the map, exports it and builds it in Workspace. Press Cancel and nothing is made or spent. The import and the build are each one undo step (Ctrl+Z).

From another plugin or a script you run in Studio, require the module the plugin keeps in CoreGui:

local BloxMaps = require(game:GetService("CoreGui"):WaitForChild("BloxMaps"))

local result = BloxMaps:GenerateMap("a desert canyon with a bandit camp", {
	size = "large",                       -- small, medium (the default), large, huge (your plan decides)
	theme = "western",                    -- optional: theme, time ("day", "sunset", "dawn", "night"), layout, seed
	mustHaves = { "a river", "a bridge" },-- optional, up to 6
	uploadModels = true,                  -- false: build the layout with stand-ins, fill them in later
})

if result.ok then
	print("Built", result.name, "for", result.creditsSpent, "credits; balance", result.balance)
	print(result.model:GetFullName())     -- the map's folder in Workspace
else
	warn(result.error, result.message)    -- cancelled, sign_in, edit_only, busy, bad_request, failed...
end

print(BloxMaps:GetBalance().balance)      -- credits left
print(BloxMaps:GetOptions().sizes)        -- what your plan can make

• GenerateMap waits until the map is built (or cancelled) and never throws: check result.ok.
• It only works in Edit mode. During Play, and in live games, it answers edit_only.
• Your sign-in stays in the plugin's own settings. Nothing about it is put in the place, so sharing a place file never shares your account.
• One job at a time: a second call while one runs answers busy.

API keys (your own server or tools)#

1. Open your account page and find API keys.
2. Give the key a name, pick its scopes, a daily credit cap (default 50, at most 1000) and a rate limit (default 30 requests a minute, at most 120), and press Create key.
3. Copy the key (bm_live_...). It is shown once: we only keep a fingerprint of it. Lost it? Revoke it and make a new one.

Scopes: generate:map (start maps and read their status and previews), export:map (export maps to studio (spends credits) and download their models). You can have 10 active keys. A key works only on /api/v1; revoking it stops it at once.

Endpoints#

Base URL https://bloxmaps.com/api/v1. Send Authorization: Bearer bm_live_... on every call. Bodies and answers are JSON.

The models a manifest lists download from the URLs in it (/api/models/...) with the same key. As on the website, an export only ships models your account hasn't received before.

Example#

KEY=bm_live_your_key_here
curl -s -X POST https://bloxmaps.com/api/v1/maps -H "Authorization: Bearer $KEY" \
     -H "Content-Type: application/json" \
     -d '{"prompt": "a snowy village with a castle", "size": "medium", "must_haves": ["a frozen lake"]}'
# -> {"id": "k3J9xQ2mLp", "status": "queued", "export_cost": 2, ...}

curl -s https://bloxmaps.com/api/v1/maps/k3J9xQ2mLp -H "Authorization: Bearer $KEY"
# poll until "status": "done", then:

curl -s -X POST https://bloxmaps.com/api/v1/maps/k3J9xQ2mLp/export -H "Authorization: Bearer $KEY" \
     -H "Idempotency-Key: village-2026-10-10-001" -H "Content-Type: application/json" -d '{"max_credits": 2}'
# -> {"export_id": "...", "status": "done", "credits_spent": 2, "balance": 18, "manifest": {...}}

Errors#

Every error is JSON: {"error": "code", "message": "what happened"} plus fields that help.