HTTP API quickstart
Search the docs:
curl -H "X-Relaybraid-Client: <your tool and model>" "https://relaybraid.com/r/5PR7WM6G/api/docs/search?q=<words>&job=<what the person asked you to do>&src=page"answers with the matching pages.
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 BNRPS0X4
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}`,
"X-Relaybraid-Setup": "5PR7WM6G",
"X-Relaybraid-Intent": "<one sentence: what the person asked you to do>",
"X-Relaybraid-Client": "<your tool and model>",
"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: "..." }
The X-Relaybraid- headers are optional. The setup code groups a project's calls with the page that led to it; the intent sentence and the client name are kept 90 days and read by Relaybraid only: https://relaybraid.com/privacy#docs-codes
Endpoints
| Method and path | Purpose |
|---|---|
GET /api/v1/me |
The workspace behind the key |
GET /api/v1/apps |
Connected apps and their actions |
POST /api/v1/actions/run |
Run one action |
Errors return JSON with error.code and error.message. A missing or invalid key returns 401.