Faivri Docs
Docs / Guides

Get started

Build with Faivri

Documentation

Build with Faivri

Practical docs for shipping, not theory. Plug in the SDK, call analyze(), and start showing fair-range verdicts in your product in under five minutes.

Live schemaTyped SDK

Quickstart

Three calls, one verdict, ready to render. The full sequence in plain TypeScript is below — read each card top-to-bottom.

01

Install the SDK

Drop the typed TypeScript client into your app — one import, zero setup.

02

Call analyze()

Send the quote text, optional price, and location. Get a fair range plus evidence back.

03

Use negotiate() output

Generate scripts with target and walk-away price for real conversations.

SDK guide

The TypeScript client wraps every endpoint, surfaces typed errors, and works the same on the server and in the browser.

TypeScript client

Setup, auth, analyze, negotiate, usage quotas, and error handling — everything you need to ship.

Open SDK guide

Best practices

Production mindset

Use confidence scores and source counts before automating downstream decisions.

Security basics

Send bearer tokens for user-scoped routes and avoid exposing private credentials in browsers.