Abschnitte der Dokumentation

Provenienz

Jedes Ergebnis gibt an, wie es berechnet wurde: Jedes Rechnerergebnis, jeder Batch-Eintrag und jedes Jobergebnis trägt ein provenance-Objekt mit denselben neun Feldern. Die Werte daneben bleiben davon unberührt.

Die neun Felder

Felder der Provenienz
Feld	Typ	Beschreibung
`method`	string	Was die Werte berechnet hat: calculator:<slug> oder die Methode eines Job-Handlers.
`version`	string	Die Engine, die sie berechnet hat, <component>@<revision>: api@…, worker@…, mcp@…, web@…. Ein Build, der seine Revision nicht kennt, sagt das (api@dev).
`formulaRef`	string \| null	Die veröffentlichte Quelle der Formel, oder null, wo keine genannt ist.
`assumptions`	{code, text}[]	Was die Methode annimmt. Leer heißt, dass keine Annahme angegeben ist, nicht, dass es keine gibt.
`validRange`	object	status (inside, outside oder unknown), die Grenzen jeder Eingabe mit ihrer Einheit, die Eingaben außerhalb davon und, wo es eines gibt, der validierte Bereich und der größte Fehler eines angepassten Modells.
`computedAt`	string	Wann, ISO-8601 in UTC mit Millisekunden.
`inputs`	object	Die Eingaben, aus denen die Werte berechnet wurden, nach dem Einsetzen der Standardwerte.
`seed`	integer \| null	Der Seed einer zufallsbasierten Berechnung; null bei jedem Rechner.
`elapsedSeconds`	number	Wie lange die Berechnung dauerte.

Eingaben außerhalb des angegebenen Bereichs

Eine Eingabe außerhalb des Bereichs, für den ein Rechner ausgelegt ist, wird trotzdem berechnet. validRange.status lautet outside, validRange.outside nennt die Eingabe, und eine Warnung mit der Eingabe und der Grenze wird zu warnings hinzugefügt. Verwendet ein Rechner ein angepasstes Modell, gibt validRange.model den validierten Bereich des Modells und seinen größten Fehler an, und ob die Eingaben darin lagen.

Ältere Ergebnisse

Ein vor September 2026 gespeichertes Ergebnis trägt nur method, version, seed, inputs und elapsedSeconds: Lesen Sie ein fehlendes Feld als unbekannt, nicht als leer. Neue Felder können hinzukommen; keines wird umbenannt oder entfernt.

curl -X POST https://rftools.io/api/py/v1/calculate \
  -H "X-API-Key: $RFTOOLS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "vswr-return-loss",
    "inputs": {
      "vswr": 150
    }
  }'

import rftools

client = rftools.Client()  # reads RFTOOLS_API_KEY, or the key `rftools login` saved

result = client.calculate("vswr-return-loss", {"vswr": 150})
print(result.values)
print(result.warnings, result.provenance.formula_ref)

const response = await fetch("https://rftools.io/api/py/v1/calculate", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.RFTOOLS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "slug": "vswr-return-loss",
    "inputs": {
      "vswr": 150
    }
  }),
});
console.log(response.status, await response.json());

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "slug": "vswr-return-loss",
	  "inputs": {
	    "vswr": 150
	  }
	}`)
	req, err := http.NewRequest("POST", "https://rftools.io/api/py/v1/calculate", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("RFTOOLS_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

application/json

{
  "slug": "vswr-return-loss",
  "values": {
    "gamma": 0.9867549668874173,
    "returnLoss": 0.11581357761790759,
    "mismatchLoss": 15.798026442026972,
    "reflectedPct": 97.3685364676988,
    "transmittedPct": 2.6314635323012037
  },
  "warnings": [
    "Input 'vswr' = 150 is outside the range this calculator is stated for (1 to 100 :1); the result is extrapolated."
  ],
  "errors": [],
  "provenance": {
    "method": "calculator:vswr-return-loss",
    "version": "api@3f2c1a9b04de",
    "formulaRef": "Pozar, \"Microwave Engineering\" 4th ed., Chapter 2",
    "assumptions": [],
    "validRange": {
      "status": "outside",
      "bounds": {
        "vswr": {
          "min": 1,
          "max": 100,
          "unit": ":1"
        }
      },
      "outside": [
        "vswr"
      ],
      "model": null
    },
    "computedAt": "2026-09-24T14:05:11.003Z",
    "inputs": {
      "vswr": 150
    },
    "seed": null,
    "elapsedSeconds": 0.003
  }
}

Berechnet, in validRange.outside markiert, mit einer Warnung.

{
  "slug": "vswr-return-loss",
  "values": {
    "gamma": 0.3333333333333333,
    "returnLoss": 9.54242509439325,
    "mismatchLoss": 0.5115252244738131,
    "reflectedPct": 11.11111111111111,
    "transmittedPct": 88.88888888888889
  },
  "warnings": [],
  "errors": [],
  "provenance": {
    "method": "calculator:vswr-return-loss",
    "version": "api@3f2c1a9b04de",
    "formulaRef": "Pozar, \"Microwave Engineering\" 4th ed., Chapter 2",
    "assumptions": [],
    "validRange": {
      "status": "inside",
      "bounds": {
        "vswr": {
          "min": 1,
          "max": 100,
          "unit": ":1"
        }
      },
      "outside": [],
      "model": null
    },
    "computedAt": "2026-09-24T14:05:11.003Z",
    "inputs": {
      "vswr": 2
    },
    "seed": null,
    "elapsedSeconds": 0.003
  }
}