Kumpix API

Build measured 3D jewelry models with Kumpix templates from your own website or software. Each model is built by the real engine and comes back with its weight, stones, dimensions and a GLB file.

Create an API key

Authentication

Every request carries the header Authorization: Bearer KPXA-…. Create the key on Account → API and keep it on your server only; never put it in browser code.

Endpoints

`GET`	`/v1/templates`	Templates and their parameters: field names, options and limits.
`POST`	`/v1/models`	Builds a model from a template and returns its weight, stone count, dimensions and a GLB link. 1 credit; a model already built with the same settings is free.
`GET`	`/v1/models/<id>.glb`	The model's GLB file (Y up, metres; true size in AR).
`GET`	`/v1/credits`	Credits left: your plan's credits this month and your packs.

Example request

curl -X POST https://motor.kumpix.com/v1/models \
  -H "Authorization: Bearer KPXA-…" \
  -H "Content-Type: application/json" \
  -d '{"type": "band", "params": {"width": 4, "ring_size": "US 7", "metal": "18k_gold"}}'

Example response

{
  "id": "5f1c0a9e7b2d4c6e8a0b1c2d",
  "type": "band",
  "metal": "18k_gold",
  "grams": 4.12,
  "stones": 0,
  "dimensions": { "width_mm": 4.0, "inner_diameter_mm": 17.35 },
  "model": "https://motor.kumpix.com/v1/models/5f1c0a9e7b2d4c6e8a0b1c2d.glb",
  "charged": true,
  "credits_left": 299
}

Error codes

`400`	Invalid template or parameter; the message in the response says why.
`401`	No key, an invalid key, or no active plan on its account.
`402`	Not enough credits; you can buy a credit pack from your account.
`429`	The limit of 60 requests per minute per key was exceeded.

Limits and cost

Up to 60 requests per minute per key. Credit prices and plans are on the Pricing page. Pricing