Quickstart

1. 1

   Step 1: Top up your API wallet

   Sign up, or sign in with your mnml.ai account, then add funds on the console’s Billing page. Your Studio plan and balance do not pay for API calls.

2. 2

   Step 2: Create an API key

   Open API keys in the console, create a key and copy it. It is shown only once, so save it as an environment variable now.

   TerminalCopy

   1export MNML_API_KEY=mk_live_…

3. 3

   Step 3: Send a render

   Send an image and a prompt. The answer comes straight away with a job id, and charges $0.2475 for v4.6.

   curlTypeScriptPython

   Copy

   1curl -X POST https://api.mnml.ai/v2/renders \2  -H "Authorization: Bearer $MNML_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "engine": "v4.6-ultra",6    "mode": "exterior",7    "image": "https://example.com/massing.png",8    "prompt": "Timber facade, late afternoon, olive trees"9  }'

   Answer · 202Copy

   1{2  "success": true,3  "data": {4    "id": "10482",5    "status": "queued",6    "charged_usd": 0.2475,7    "credits_charged": 25,8    "replayed": false,9    "notes": [],10    "ids": [11      "10482"12    ]13  }14}

4. 4

   Step 4: Get the result

   Ask for the job every few seconds. When its status is succeeded, outputs[0].url is your render: download it, as the link expires after an hour or two.

   curlTypeScriptPython

   Copy

   1curl https://api.mnml.ai/v2/jobs/10482 \2  -H "Authorization: Bearer $MNML_API_KEY"

Or use an SDK

The official SDKs make the same calls, wait for the job for you, retry safely and verify webhooks. Each reads your key from MNML_API_KEY.

1import { Mnml } from '@mnml-ai/sdk';2 3const mnml = new Mnml(); // reads MNML_API_KEY4 5const [job] = await mnml.renders.createAndWait({6  mode: 'exterior',7  image: 'https://example.com/massing.png', // or the file's bytes: await readFile('massing.png')8  prompt: 'Timber facade, late afternoon light, olive trees',9});10console.log(job?.status, job?.outputs[0]?.url);

More recipes for each language are on the SDKs page.

Next steps