API reference

1. Get an API key

1. Create a free account and verify your email - credits arrive immediately, and top up again every week.
2. Open your profile and generate an API key.
3. Send it in the body of every API call as api_key.

Keys are free, start with I2M_ and are 52 characters long. Generating a new one revokes the previous one immediately. Keep it to yourself: anyone holding your key spends your credits. There is no endpoint that creates an account or a key - both need a signed-in browser, on purpose.

2. The whole loop

Submit, poll until it is finished, download. Nothing else is required.

KEY=I2M_your_key_here

# submit
curl -X POST https://img2model.com/api/jobs/new \
  -F "api_key=$KEY" \
  -F "new_job_form[image]=@chair.png" \
  -F "new_job_form[mode]=simple_pbr" \
  -F "new_job_form[detail]=3" \
  -F "new_job_form[polycount]=25000"
# {"success":true,"message":"Job created","job_id":"019fd4...","remaining_credits":471}

# poll every few seconds until "finished":true
curl -X POST https://img2model.com/api/jobs/status/019fd4... -d "api_key=$KEY"
# {"success":true,"state":"IN_PROGRESS","state_hr":"Being processed","finished":false,...}

# download
curl -X POST https://img2model.com/api/jobs/result/019fd4... -d "api_key=$KEY" -o chair.glb

A default job takes about 41 seconds. Poll every 3-10 seconds - the API has no push channel, and hammering it does not make the GPU faster.

3. Endpoints

POST /api/jobs/new - Submit a job

Uploads an image and queues it. Costs credits the moment it is accepted. Encoding: multipart/form-data (the image is a file upload).

Returns the submission response below.

POST /api/jobs/status/{id} - Poll a job

Where the job is, and - once it is done - what came back. Poll this until `finished` is true. Encoding: application/x-www-form-urlencoded.

Returns the status response below.

POST /api/jobs/result/{id} - Download the result

Streams the finished model. Only valid once the job is COMPLETED. Encoding: application/x-www-form-urlencoded.

Returns the file itself, with the format's own Content-Type and a filename ending in .glb or .vox. A job that is not finished - or not yours - gets a JSON refusal instead, so check whether the first byte is { before writing the body to disk.

4. Responses

Submission response

Status response

5. Job fields

Everything describing the job is posted under the new_job_form[…] prefix, because the API and the website submit the same form. Only the image is required; every field left out means the default in these tables, not null.

The job

The whole surface. These are exactly the controls the website's own generator has, and every one of them is optional except the image.

Model types

The values mode takes. Set this and leave the rest at their defaults unless you have a reason not to.

Plan limits

Your plan caps what you may order. Going over is a refusal rather than a quietly reduced job, and nothing is charged for it - the message names the setting and the plan that lifts it.

The same job costs the same credits on every plan - a plan only moves the ceilings. See your plan.

6. Rules that are not visible in any one field

• One job at a time. A submission is refused while any earlier job of yours is still NEW, QUEUED or IN_PROGRESS. Poll the previous job to `finished` before submitting the next.
• Failed jobs are free. Credits are charged at submission and a job that ends FAILED or REJECTED stops counting against your balance, which is the refund. Nothing needs to be claimed.
• A mode wins over the switches it stands for. `mode` is a name for the texture settings, so posting `mode=full_pbr` together with `auto_texture=0` gives you the mode - textures and all. Ask for `mode=textureless` when you want bare geometry.
• Every mode goes up to a million faces. No mode is capped below the `polycount` range, and a dense mesh costs storage rather than much more time. What the *account* may order is a separate thing - see the plan table below.
• Your plan caps polycount, texture size and Full PBR. The free plan stops at 250,000 faces, 2048 textures, 256 voxels and simple_pbr. Going over is a refusal, not a silently reduced job, and the `message` says which plan lifts it. Nothing is charged for a refused submission.
• Unknown fields are an error. Posting a name this page does not list fails the whole submission with "This form should not contain extra fields" rather than ignoring it - so a typo cannot silently cost you a job at the defaults. Names retired from earlier versions of this API are the exception, and are accepted and dropped so that older clients keep working: `smoothness` still means `polycount`, `remove_background` is now always done, and the per-stage tuning parameters are no longer part of the public API.

7. What a job costs

Credits are charged when the job is accepted, and the price is the estimated GPU time plus a little for storing the result. A job that ends failed or rejected costs nothing - there is nothing to claim.

• Cheapest possible job: 39 credits
• Default job: 52 credits, about 41 seconds
• Turning textures off or dropping the detail level is where the real savings are

There is no price-quote endpoint for API clients - the website's calculator is browser-only and CSRF-protected. Read remaining_credits off the submission response, or check your billing page.

8. When it goes wrong

9. Blender, without writing any of this

The add-on is this API with a panel on it: generate meshes from images inside Blender, and texture existing meshes automatically. Follow the installation guide.