HTTP API quickstart

Base URL: https://relaybraid.com/api/v1. Authenticate with Authorization: Bearer <api key>.

Get a key with the CLI:

npx -y https://relaybraid.com/dl/relaybraid-cli.tgz init --ref CT8710F5

Sign in

npx -y https://relaybraid.com/dl/relaybraid-cli.tgz login

login prints a sign-in URL and a one-time code. Open the URL in a browser, check that the code matches and approve. The command finishes by itself once the sign-in is approved, usually within a minute, and saves the API key in .relaybraid/credentials.json.

Run an action

const response = await fetch("https://relaybraid.com/api/v1/actions/run", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RELAYBRAID_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ app: "slack", action: "send_message", input: { channel: "#orders", text: "New order received" } }),
});
const result = await response.json(); // { status: "success", run_id: "..." }

Endpoints

Errors return JSON with error.code and error.message. A missing or invalid key returns 401.