Getting Started

Welcome to Taffrail

Taffrail delivers personalized, compliant financial advice for banks and brokerages through a deterministic Rules Engine. Integrate via the API, the embed widget, or the hosted AdviceLink page.

Quickstart

Three steps to your first API call.

1. Get an API key from Advice Builder or contact us.

2. Call the Advice API:

curl -X GET "https://engine-staging.taffrail.com/api/advice/TFU3nYztaJ8yxgNGQkGsP7k" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Accept: application/vnd.taffrail.json+html" \
  -H "Taffrail-Version: 2"

3. Inspect the response:

{
  "id": "393v-NbKSn5yguFu_OrJN",
  "data": {
    "advice": [
      {
        "headline": "Congratulations, your configuration is setup!",
        "headline_html": "<p>Congratulations, your configuration is setup!</p>\n",
        "summary": "Browse the library of Advice Rules and start integrating with our API.",
        "type": "ADVICE"
      }
    ],
    "adviceset": {
      "id": "TFU3nYztaJ8yxgNGQkGsP7k",
      "title": "API Testing only"
    }
  }
}

For the full request, JavaScript and Python clients, and a walkthrough of the response, see the Hello World recipe.

Integration options

Advice Embed — A drop-in HTML snippet or Web Component. The fastest way to get started.
Advice API — A direct REST integration when you need full control over the UI.
AdviceLink — A branded, hosted page for your advice content. Contact us for details.

Next steps

Authentication — set up your API key.
Environments — Staging and Production endpoints.
Headers — required request and response headers.
Advice Content Types — pick a response format.
Taffrail User Experience — chips, Backlinks, and the interaction model.

Questions? Contact support or visit support.taffrail.com.