Seções da documentação

Documentação da API

Integre 255 calculadoras de RF e eletrônica e 13 ferramentas de simulação aos seus scripts, notebooks e aplicações via REST. Um endpoint executa qualquer calculadora; os simuladores rodam como trabalhos que você envia e consulta. Todo resultado diz como foi calculado.

URL base https://rftools.io/api/py/v1. Envie sua chave no cabeçalho X-API-Key. Uma chave gratuita cobre 5 chamadas por mês; obtenha a sua no painel.

A primeira requisição

Envie por POST o slug de uma calculadora e as suas entradas para /calculate. A resposta traz cada saída pelo nome, os avisos e um objeto de procedência que indica a fórmula, a versão do motor e se as entradas estavam dentro da faixa para a qual a calculadora é declarada. O código ao lado deste texto é a chamada, em quatro linguagens, e a resposta que a API devolve para ela.

Endpoints

Todos os endpoints públicos
Endpoint	O que faz	Contabilização
POST /api/py/v1/calculate	Executar uma calculadora com as suas entradas.	Uma chamada
POST /api/py/v1/calculate/batch	Executar até 50 cálculos em uma requisição.	Uma chamada por item calculado
POST /api/py/v1/calculate/solve	Encontrar o valor de entrada que leva uma saída a um alvo, com o resultado direto nesse ponto.	Uma chamada
GET /api/py/v1/usage	A cota do mês, o que foi usado e o que resta, por chave; ?days=N adiciona as chamadas de cada um dos últimos N dias.	Nunca
GET /api/py/v1/jobs/types	Cada tipo de trabalho de simulação, com os seus planos, o tempo máximo, os limites e os uploads.	Nunca
GET /api/py/v1/jobs/types/{job_type}	O contrato de parâmetros de um tipo de trabalho, em JSON Schema.	Nunca
POST /api/py/v1/jobs/estimate	Quanto um trabalho custaria e quanto tempo rodaria, sem enviá-lo.	Nunca
POST /api/py/v1/upload	Um formulário pré-assinado para o arquivo de entrada de um trabalho.	Nunca
POST /api/py/v1/jobs	Enviar um trabalho de simulação.	Uma chamada, com uma chave
GET /api/py/v1/jobs/{job_id}	O status e o progresso de um trabalho e, depois de concluído, o link do resultado.	Nunca
GET /api/py/v1/jobs	Os trabalhos recentes do chamador, de todas as chaves da conta.	Nunca
POST /api/py/v1/apikeys	Criar uma chave para a conta conectada.	Nunca
POST /api/py/v1/oauth/device/code	Iniciar a autorização de dispositivo: um código para o usuário aprovar.	Nunca
POST /api/py/v1/oauth/device/token	Buscar a chave depois que o usuário aprovou o código.	Nunca
GET /api/py/health	Status do serviço.	Nunca

Tipos de trabalho de simulação

13 simuladores rodam como trabalhos assíncronos: envie, consulte, leia o resultado. Cada tipo de trabalho publica o seu contrato de parâmetros; veja Trabalhos de simulação.

Tipos de trabalho de simulação
jobType	Simulador
antenna_sim	Simulador de antena de fio (NEC-2)
emi_radiated	Estimador de emissões radiadas EMI
eye_diagram	Diagrama ocular a partir dos parâmetros S
fdtd_sparam	Simulador de linha de transmissão FDTD
filter_monte_carlo	Análise de Monte Carlo de Filtro RF
impedance_match	Sintetizador de correspondência de impedância de banda larga
magnetics_optimizer	Otimizador de design magnético e de transformadores
pdn_impedance	Analisador de impedância PDN e otimizador de capacitor de desacoplamento
radar_detection	Desempenho de detecção de radar em Monte Carlo
rf_cascade	Analisador de orçamento RF Cascade
sat_link_budget	Orçamento de links terrestres e de satélites
smps_control_loop	Analisador de estabilidade do circuito de controle SMPS
sparam_pipeline	Pipeline de análise de parâmetros S

Próximos passos

Início rápidoUma chave e uma primeira chamada em um minuto.AutenticaçãoChaves, o link de chave e a autorização de dispositivo.CalcularA requisição, a resposta e as suas recusas.Slugs e entradasAs entradas, as saídas e um exemplo de cada calculadora.Biblioteca Pythonpip install rftools-io: chamadas tipadas e uma CLI.Servidor MCPAs mesmas calculadoras e simulações para agentes de IA.

Referência legível por máquina

Pronto para integrar?

Obtenha sua chave e faça uma requisição em menos de um minuto. 10.000 chamadas por mês no plano API, 120 requisições por minuto com uma chave, todas as 255 calculadoras.

Obter acesso à API, $19/mês Gerenciar chaves Obter uma chave de API gratuita

Ou obtenha uma chave gratuita (5 chamadas por mês) no seu painel; não é preciso cartão de crédito.

A primeira requisição

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