Sections de la documentation

Documentation de l'API

Intégrez 255 calculateurs RF et électronique et 13 outils de simulation à vos scripts, notebooks et applications via REST. Un seul point de terminaison exécute n'importe quel calculateur ; les simulateurs s'exécutent comme des tâches que vous soumettez puis suivez. Chaque résultat indique comment il a été calculé.

URL de base https://rftools.io/api/py/v1. Envoyez votre clé dans l'en-tête X-API-Key. Une clé gratuite couvre 5 appels par mois ; obtenez-la sur votre tableau de bord.

La première requête

Envoyez en POST le slug d'un calculateur et ses entrées à /calculate. La réponse contient chaque sortie sous son nom, les avertissements et un objet de provenance qui indique la formule, la version du moteur et si les entrées se trouvaient dans la plage pour laquelle le calculateur est prévu. Le code à côté de ce texte est l'appel, en quatre langages, et la réponse que l'API renvoie.

Points de terminaison

Tous les points de terminaison publics
Point de terminaison	Ce qu'il fait	Décompté
POST /api/py/v1/calculate	Exécuter un calculateur sur ses entrées.	Un appel
POST /api/py/v1/calculate/batch	Exécuter jusqu'à 50 calculs en une seule requête.	Un appel par élément calculé
POST /api/py/v1/calculate/solve	Trouver la valeur d'entrée qui amène une sortie à une cible, avec le résultat direct à cette valeur.	Un appel
GET /api/py/v1/usage	Le quota du mois, ce qui est consommé et ce qui reste, par clé ; ?days=N ajoute les appels de chacun des N derniers jours.	Jamais
GET /api/py/v1/jobs/types	Chaque type de tâche de simulation, ses offres, sa durée maximale, ses limites et ses fichiers.	Jamais
GET /api/py/v1/jobs/types/{job_type}	Le contrat de paramètres d'un type de tâche, en JSON Schema.	Jamais
POST /api/py/v1/jobs/estimate	Ce que coûterait une tâche et sa durée, sans la soumettre.	Jamais
POST /api/py/v1/upload	Un formulaire présigné pour le fichier d'entrée d'une tâche.	Jamais
POST /api/py/v1/jobs	Soumettre une tâche de simulation.	Un appel, avec une clé
GET /api/py/v1/jobs/{job_id}	Le statut et la progression d'une tâche et, une fois terminée, le lien vers son résultat.	Jamais
GET /api/py/v1/jobs	Les tâches récentes de l'appelant, de toutes les clés du compte.	Jamais
POST /api/py/v1/apikeys	Créer une clé pour le compte connecté.	Jamais
POST /api/py/v1/oauth/device/code	Lancer l'autorisation d'appareil : un code que l'utilisateur approuve.	Jamais
POST /api/py/v1/oauth/device/token	Récupérer la clé une fois que l'utilisateur a approuvé le code.	Jamais
GET /api/py/health	État du service.	Jamais

Types de tâches de simulation

13 simulateurs s'exécutent comme des tâches asynchrones : soumettre, suivre, lire le résultat. Chaque type de tâche publie son contrat de paramètres ; voir Tâches de simulation.

Types de tâches de simulation
jobType	Simulateur
antenna_sim	Simulateur d'antenne filaire (NEC-2)
emi_radiated	Estimateur d'émissions rayonnées EMI
eye_diagram	Schéma oculaire à partir de S-Parameters
fdtd_sparam	Simulateur de ligne de transmission FDTD
filter_monte_carlo	Analyse Monte Carlo du filtre RF
impedance_match	Synthétiseur d'adaptation d'impédance haut débit
magnetics_optimizer	Optimiseur de conception des composants magnétiques et des transformateurs
pdn_impedance	Analyseur d'impédance PDN et optimiseur de condensateur de découplage
radar_detection	Performances de détection radar Monte Carlo
rf_cascade	Analyseur de budget RF Cascade
sat_link_budget	Budget des liaisons par satellite et terrestre
smps_control_loop	Analyseur de stabilité de boucle de contrôle SMPS
sparam_pipeline	Pipeline d'analyse des paramètres S

Pour aller plus loin

Démarrage rapideUne clé et un premier appel en une minute.AuthentificationLes clés, le lien de clé et l'autorisation d'appareil.CalculerLa requête, la réponse et ses refus.Slugs et entréesLes entrées, les sorties et un exemple pour chaque calculateur.Bibliothèque Pythonpip install rftools-io : appels typés et une CLI.Serveur MCPLes mêmes calculateurs et simulations pour les agents d'IA.

Référence lisible par machine

Prêt à intégrer ?

Obtenez votre clé et envoyez une requête en moins d'une minute. 10 000 appels par mois avec l'offre API, 120 requêtes par minute avec une clé, les 255 calculateurs.

Obtenir l'accès à l'API, $19/mois Gérer les clés Obtenir une clé d'API gratuite

Ou obtenez une clé gratuite (5 appels par mois) sur votre tableau de bord ; aucune carte bancaire requise.

La première requête

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": 2
    }
  }'

import rftools

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

result = client.calculate("vswr-return-loss", {"vswr": 2})
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": 2
    }
  }),
});
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": 2
	  }
	}`)
	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))
}

200application/json

{
  "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
  }
}