Guide
API reference
A high-level overview of programmatic access to Kyros — from API key to authentication.
1. Create an API key
In the app, open the Developer Access section. That’s where you create and manage your API keys. Treat a key like a password: keep it secret, use it server-side only, and revoke and re-issue it immediately if you suspect it leaked.
2. Authenticate with a bearer key
You authenticate requests with the standard bearer token mechanism: send your API key in the Authorization header. Conceptually, it looks like this:
Authorization: Bearer YOUR_API_KEYExact endpoints, fields and example payloads always live in the app next to your key — there the reference is bound to the version actually enabled for you, which makes it more reliable than any static copy.
3. What programmatic access means
At a high level, the API lets you talk to Kyros from your own systems, not just through the embedded widget. That’s the foundation for custom integrations: consult an assistant from a backend, feed results back into an internal tool, or wire Kyros into an existing workflow.
4. Actions from interactive cards
For many integrations you don’t need a custom API client at all. The actions on an interactive card can call your own API or run your app’s code, switch screens, send a chat message or open a link. That’s how you connect Kyros to your systems — for lead capture, product tiles or approvals — straight from the conversation, without separate backend work.
Want to connect a specific platform? See the integrations. For a plain embed, the embedding guide is all you need.