Executar bot

Coloca uma execução de bot na fila, como se ela fosse disparada manualmente na plataforma. A execução segue as mesmas regras da fila e aparece em Execuções assim que começa.

Só o bot_name é obrigatório. Sem bot_version e agent_name, o Sinfonia usa a versão release do bot e o agente configurado nela. Sem bot_params, usa os parâmetros padrão do bot.

POST /v1/run

URL base: https://sinfonia.live/api

Headers

token stringobrigatório

Token do tipo API, gerado em Administração → Tokens.

Exemplo: SEU_TOKEN

Content-Type stringobrigatório

Sempre application/json.

Exemplo: application/json

Corpo da requisição

bot_name stringobrigatório

Nome do bot a executar.

Exemplo: bot-notas-fiscais

bot_version stringopcional

Versão do bot. Se omitida, usa a versão release.

Exemplo: 1.0.0

agent_name stringopcional

Agente que vai executar o bot. Se omitido, usa o agente da versão release.

Exemplo: SVWPRD0027

bot_params stringopcional

Parâmetros da execução, como um JSON serializado em string. Se omitido, usa os parâmetros padrão do bot.

Exemplo: {"PARAM1": "123", "PARAM2": "value2"}

label stringopcional

Rótulo livre para identificar a execução na plataforma.

Exemplo: api-test

webhook_url stringopcional

URL que recebe um POST quando a execução terminar. Veja Webhook de retorno.

Exemplo: https://meusistema.com/webhooks/sinfonia

Exemplo de requisição

curl -X POST "https://sinfonia.live/api/v1/run" \
  -H "token: SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "bot_name": "bot-notas-fiscais",
    "bot_version": "1.0.0",
    "agent_name": "SVWPRD0027",
    "bot_params": "{\"PARAM1\": \"123\", \"PARAM2\": \"value2\"}",
    "label": "api-test",
    "webhook_url": "https://meusistema.com/webhooks/sinfonia"
  }'

const response = await fetch("https://sinfonia.live/api/v1/run", {
  method: "POST",
  headers: {
    "token": "SEU_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "bot_name": "bot-notas-fiscais",
    "bot_version": "1.0.0",
    "agent_name": "SVWPRD0027",
    "bot_params": "{\"PARAM1\": \"123\", \"PARAM2\": \"value2\"}",
    "label": "api-test",
    "webhook_url": "https://meusistema.com/webhooks/sinfonia"
  }),
});

console.log(response.status);

import requests

response = requests.post(
    "https://sinfonia.live/api/v1/run",
    headers={"token": "SEU_TOKEN"},
    json={
      "bot_name": "bot-notas-fiscais",
      "bot_version": "1.0.0",
      "agent_name": "SVWPRD0027",
      "bot_params": "{\"PARAM1\": \"123\", \"PARAM2\": \"value2\"}",
      "label": "api-test",
      "webhook_url": "https://meusistema.com/webhooks/sinfonia"
    },
)

print(response.status_code)

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "bot_name": "bot-notas-fiscais",
	  "bot_version": "1.0.0",
	  "agent_name": "SVWPRD0027",
	  "bot_params": "{\"PARAM1\": \"123\", \"PARAM2\": \"value2\"}",
	  "label": "api-test",
	  "webhook_url": "https://meusistema.com/webhooks/sinfonia"
	}`)

	req, err := http.NewRequest("POST", "https://sinfonia.live/api/v1/run", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("token", "SEU_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Respostas

Execução adicionada à fila. A resposta não tem corpo.

Observações

A resposta de sucesso não traz o número da execução. Para saber quando ela terminou e com qual resultado, informe uma webhook_url: o Sinfonia envia o exec_id e o status para ela ao final. Veja Webhook de retorno.
O bot_params é uma string contendo um JSON, e não um objeto. Serialize os parâmetros antes de enviar, por exemplo com JSON.stringify ou json.dumps.
Os parâmetros chegam ao bot como nas outras formas de execução. Veja como lê-los em Exemplos de Scripts.

Última modificação em 03/11/2026

Autenticação Log da execução