The API.
Put our designs in your own shop. Your customers choose a design and their sizes on your site; the API makes its plans, cut list, drawings and 3D files, for you to give them or build from.
Getting started
- Take Business, €50.00$50.00£45.00 a month.
- Make a key on your account page. It is shown once: keep it on your server, never in a web page.
- Send it with every request in an
X-API-Keyheader, tohttps://aicarpenter.eu/api/v1.
Tokens
Business comes with 2000 tokens a month for the API: up to 200 designs, each with one kind of file. What you order is paid from them:
- A design Premium includes: 0 tokens.
- A design sold on its own: its Premium price in tokens, rounded to 10, less 20. A €6.99 design is 200.
- Each kind of file of an order (its plans, cut list, STEP, STL, GLB, part drawings or CNC files): 10 tokens the first time you download it, then as often as you like.
- Free designs, and their files, cost nothing.
Ask any design's price, and your tokens left, before you order. Tokens start again each month; unused ones don't carry over. An order whose design could not be made gives its tokens back.
Endpoints
GET /accountYour tokens a month, those left, and when they come back.GET /designsEvery design you can order, with its prices in tokens.GET /designs/{id}One design: its sizes and choices, and what each may be (JSON Schema).GET /designs/{id}/priceIts prices in tokens, and your tokens left.POST /ordersOrder a design, as it is or at your customer's sizes. Its plans are made at once.GET /ordersThe orders you have made.GET /orders/{id}One order: its files, and which kinds you have taken.GET /orders/{id}/files/{name}One of its files: plans.pdf, cut_list.csv, model.step, model.stl, model.glb, a part's .svg or .dxf (plans_in.pdf and cut_list_in.csv in inches).GET /orders/{id}/bundle/{drawings|cnc}All its part drawings, or all its CNC cut files, as one ZIP.
Examples
A design's price, and your tokens left:
curl -H "X-API-Key: aic_…" \
https://aicarpenter.eu/api/v1/designs/kitchen_cabinet/price
{"id": "kitchen_cabinet",
"tokens": {"as_is": 0, "with_sizes": 0, "per_kind_of_file": 10},
"tokens_left": 2000}An order at your customer's width (the names and limits of each size come from GET /designs/{id}):
curl -X POST -H "X-API-Key: aic_…" \
-H "content-type: application/json" \
-d '{"design": "kitchen_cabinet", "numbers": {"width": 600}}' \
https://aicarpenter.eu/api/v1/ordersIts plans, from the order's id:
curl -H "X-API-Key: aic_…" -o plans.pdf \ https://aicarpenter.eu/api/v1/orders/<order id>/files/plans.pdf
Good to know
- At most 60 requests a minute. An order builds its design, which takes seconds, or a few minutes for the biggest.
- Answers are JSON; an error says why in
detail: 401 a key not known or revoked, 402 Business needed or too few tokens left, 404 nothing there, 409 an order that cannot be made so, 429 too fast. - Orders made through the API stay in the API; they don't show among your designs on this site.
- What the plans may be used for is in the licence. For anything it does not cover, or for more tokens, ask us with the box on the pricing page.