API Voima Toolbox – Executar Projeto

Esta rota executa um projeto existente, permitindo alterar valores de entrada em blocos de cálculo e recuperar as saídas desejadas.

Endpoint

POST https://voimatoolbox.com/api/v1/run_project

Autenticação

Todas as requisições devem conter sua chave da API no cabeçalho Authorization:

Authorization: <SUA_CHAVE_DE_API>

Cabeçalhos obrigatórios

Cabeçalho	Valor
Authorization	obrigatório – sua chave da API
Content-Type	application/json
Accept	application/json (opcional)

Corpo da requisição


json
{
  "projectId": "string",
  "inputs": [
    {
      "blockName": "string",
      "interfaceName": "string",
      "value": "number | string | boolean"
    }
  ],
  "outputs": [
    "string"
  ]
}

Campo	Tipo / Formato	Obrigatório	Descrição
projectId	string	Sim	Identificador do projeto salvo no Voima Toolbox.
inputs	Array	Não¹	Lista de parâmetros que você deseja alterar antes da execução.
blockName	string	—	Nome do bloco de cálculo definido por você no diagrama.
interfaceName	string	—	Nome da interface dentro do bloco (ex.: "y" = Altura da água).
value	number	—	Novo valor a ser aplicado à interface indicada.
outputs	Array	Sim	Blocos dos quais você deseja obter resultados. Cada item é o nome do bloco.

¹ Se nenhum input for enviado, o projeto será executado com os valores já salvos no diagrama.

Exemplo mínimo


json
{
  "projectId": "670fa95e5f7a51af07160aa8",
  "inputs": [
    {
      "blockName": "meu_bloco_de_calculo",
      "interfaceName": "y",
      "value": 0.2
    }
  ],
  "outputs": [
    "meu_bloco_de_calculo"
  ]
}

Resposta

200 OK


json
{
  "outputs": [
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "Q", "value": 0.014595066264318644 },
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "A", "value": 0.466 },
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "B", "value": 0.457 },
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "C", "value": 0.17800000000000002 },
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "D", "value": 0.259 },
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "E", "value": 0.381 },
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "F", "value": 0.152 },
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "G", "value": 0.305 },
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "K", "value": 0.025 },
    { "blockName": "meu_bloco_de_calculo", "interfaceName": "N", "value": 0.057 }
  ]
}

Campo	Tipo	Descrição
outputs	Array	Conjunto de resultados solicitados. Cada objeto é uma interface.
blockName	string	Nome do bloco de origem do valor.
interfaceName	string	Interface específica dentro do bloco (ex.: "Q").
value	number	Valor calculado para a interface.

Boas práticas

Envie apenas os blocos necessários em outputs; isso reduz o tempo de execução e o tamanho da resposta.
Agrupe várias modificações em uma única chamada usando o array inputs.
Gere um novo projectId (ou clone) para testar cenários sem afetar o diagrama original.
Verifique unidades e domínios válidos de cada interface para evitar erros 422.

Suporte

Dúvidas adicionais? Entre em contato via contato@voimatoolbox.com.