API Quick-start

First call in under 3 minutes. Walk through sign-up, key generation, and your first Eurocode check.

Free — 10 calls/month, no key needed Pro — 1 000 calls/month Studio — unlimited

Create an account

Sign up free → — no credit card required. The free tier gives you 10 Eurocode check API calls per month, no key needed (IP-keyed).

Get your API key

Open Settings → API Keys and click New key. Give it a name (e.g. "Grasshopper plugin"). Copy the fai_… token — it's shown once.

Security: Never commit your token to source control. Export it as an env var instead: export FRAMEAI_TOKEN=fai_your_key_here

Make your first call — EN 1993-1-8 bolt check

Paste this into your terminal. Replace fai_your_key_here with your actual token (or omit the header entirely to test on the free tier):

curl -X POST https://frameai-structural.polsia.app/api/v1/check/en-1993-1-8 \
  -H "Authorization: Bearer fai_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "bolt_grade": "8.8",
    "bolt_size":  "M20",
    "shear_planes": 1,
    "plate_fu":   360,
    "plate_t":    10,
    "e1": 60, "e2": 40, "p1": 80,
    "is_end_bolt": true,
    "V_Ed": 50000
  }'

Expected response

{
  "check_id":   null,
  "endpoint":   "en-1993-1-8",
  "passed":     true,
  "utilisation": 78.3,
  "summary":    "Bolt M20 8.8: 78.3% utilisation — PASS",
  "result": {
    "F_v_Rd":       48000.0,
    "F_v_Rd_total": 48000.0,
    "F_b_Rd":       86400.0,
    "F_t_Rd":       81000.0,
    "utilisation":  78.3,
    "governing":    "shear",
    "passed":       true,
    "clause":       "EN 1993-1-8:2005 §3.5, §3.6, Table 3.4"
  },
  "eurocode_clauses_cited": ["EN 1993-1-8:2005 §3.5, §3.6, Table 3.4"],
  "api_version": "v1"
}

All available check endpoints

POST /api/v1/check/en-1993-1-8 — Bolted connections: F_v,Rd, F_b,Rd, F_t,Rd
POST /api/v1/check/en-1993-1-9 — Fatigue: Palmgren-Miner damage, S-N curves
POST /api/v1/check/en-1993-1-1 — Steel members: buckling, LTB, N+M interaction
POST /api/v1/check/en-1992-1-1 — RC columns: N-M interaction, §5.8 slenderness
POST /api/v1/check/en-1995-1-1 — Timber: bending, shear, column buckling
POST /api/v1/check/en-1998-1 — Seismic: spectrum, base shear F_b
GET /api/v1/usage — Current period usage + quota remaining

Next steps

Interactive API reference — full parameter docs + try-it panel
Download Postman collection — all endpoints pre-loaded
Upgrade to Pro or Studio for higher quotas
Full documentation — tutorials, examples, Eurocode guides

Integration patterns

Grasshopper / Rhino

Use the GhPython component with the Python example from the API reference. Pass member geometry as inputs, parse passed and utilisation as output parameters.

Excel / VBA

Use XMLHTTP60 or Power Query. Send a POST with Content-Type: application/json and parse the JSON response. A VBA snippet:

Dim xhr As Object
Set xhr = CreateObject("MSXML2.XMLHTTP.6.0")
xhr.Open "POST", "https://frameai-structural.polsia.app/api/v1/check/en-1993-1-8", False
xhr.setRequestHeader "Content-Type", "application/json"
xhr.setRequestHeader "Authorization", "Bearer fai_your_key"
xhr.Send "{""bolt_grade"":""8.8"",""bolt_size"":""M20"",""V_Ed"":50000,""plate_fu"":360,""plate_t"":10,""e1"":60,""e2"":40,""p1"":80}"
Debug.Print xhr.responseText

Tekla Open API (C#)

Use System.Net.Http.HttpClient — a full snippet is in the API reference.

Questions? Email frameai@polsia.app • Full API reference • View pricing