run-quick-design

Run Quick Design Calculator

Overview

Run any calculator from the SkyCiv Quick Design library via a single REST endpoint. The library covers 154 calculators across structural, foundation, steel, concrete, timber, aluminium, connection, and load categories.

• API endpoint: POST https://qd.skyciv.com/run
• Auth: Requires a SkyCiv API token — get yours at https://platform.skyciv.com/api
• Full calculator catalogue

---

How to call

const axios = require('axios');

axios.post('https://qd.skyciv.com/run', {
    payload: JSON.stringify({
        uid: "8004-as3600-strip-footing-design", // calculator UID from the catalogue
        auth: "[email protected]",                  // authenticated email address
        key: "YOUR_API_TOKEN",                    // from https://platform.skyciv.com/api
        pdf_report: true,                         // set false to skip PDF generation
        input: {
            // Input object matching the calculator's schema.json
            // See sample_input.json for a ready-to-use example
        }
    })
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

Request payload fields

Field	Type	Required	Description
uid	string	yes	Calculator unique identifier (see catalogue)
auth	string	yes	Authenticated user email address
key	string	yes	API token from https://platform.skyciv.com/api
pdf_report	boolean	no	Generate a PDF report (default: false)
input	object	yes	Input parameters — see each calculator's schema.json

---

Response format

{
  "status": 0,
  "data": {
    "report": "https://pdf.skyciv.com/...  (PDF link, valid for 1 hour)",
    "results": {
      "Utilization Ratio": {
        "value": 0.85,
        "info": "Ratio of demand to capacity",
        "units": "utility",
        "label": "Utilization Ratio"
      },
      "Design Check": {
        "value": "PASS",
        "units": "custom_box",
        "label": "Design Check",
        "color": "#21BA45"
      },
      "Footing Width": {
        "value": 1200,
        "info": "Calculated footing width",
        "units": "mm",
        "label": "Footing Width"
      }
    }
  },
  "log": "",
  "warnings": [],
  "msg": "Design Calc ran successfully"
}