Docs
Everything your developers need
The full developer docs will live at docs.kirkyapp.com. Until that site is public, start here: the quickstart and the security model are ready now.
Guides
What the docs cover
- Available
Quickstart
From script tag to the first answer in your app.
ReadYou’ll find
- The three install steps
- Test and Live environments
- Troubleshooting
- Coming soon
Identity and tokens
How your backend tells Kirky who the user is.
You’ll find
- ES256 signing samples for Node, Python, PHP, .NET and Java
- Claims, expiry and key rotation
- Roles and permissions
- Coming soon
SDK reference
Every option and method of the web SDK.
You’ll find
- init() options and events
- Theming the widget
- Mock mode for local development
- Coming soon
Endpoints and OpenAPI
Give Kirky read access to your live data, per role.
You’ll find
- Importing an OpenAPI file
- Writing descriptions Kirky can use
- Write endpoints and confirmations
- Coming soon
Knowledge sources
Documents Kirky answers from, and how they stay current.
You’ll find
- PDF, Word and scans
- Drive, SharePoint and Dropbox
- Bulk upload by API or CLI
- Coming soon
Centinela rules
Heads-ups before unusual data is saved.
You’ll find
- sentinel.check() before a save
- No-code form tagging
- Nightly review on Business
- Coming soon
Admin API and CLI
Automate your workspace from scripts and CI.
You’ll find
- API keys for admins, never for end users
- Uploading sources from the CLI
- Usage and audit exports
- Available
Security model
Where data goes, who can read it and what never leaves your app.
ReadYou’ll find
- Browser-side data calls
- Verified citations
- Region and subprocessors
A first look
The SDK in one screen
One global, a handful of methods. The full reference lands with the docs site.
- init(options)
- Starts the widget with your tenant, the user’s token and, optionally, getAuthHeaders, lang and a CSP nonce.
- ready()
- A promise that resolves once the widget has loaded. Calls made before that are queued.
- identify(token)
- Switches the signed-in user without reloading the page.
- logout()
- Clears the conversation and the session. Use it on shared computers.
- sentinel.check(record)
- Asks Centinela about a record before you save it. It answers in milliseconds and never blocks.
- diagnostics()
- Reports what the SDK sees: version, CSP, token state and the last errors.
// init() options, with the defaults Kirky.init({ tenant: "tn_4f7k2q", token, // ES256, ≤ 5 min getAuthHeaders, // optional lang: "es", // or "en" mode: "live", // or "mock" nonce, // strict CSP debug: false, }); await Kirky.ready();