Skip to main content
If you’re building an app for other people and each user needs their own Kyara API key, use the hosted onboarding URL instead of asking users to visit the dashboard and create keys by hand. Kyara handles sign-in, key generation, and the explanation in one hosted flow, then sends the user back to your app.

​
Onboarding URL

Direct your users to the following URL, replacing the redirect value with your own callback address:
​
string
The URL Kyara redirects the user to after they generate their key. Must be a valid http or https URL, otherwise the flow returns a 400 error. Kyara displays the destination domain to the user before sending them back, so they always know where they are going. If you omit redirect, the user lands on a standalone key-generation page with no app handoff.

​
What the user sees

1

Sign in or create a Kyara account

The user authenticates with Kyara. If they don’t have an account yet, they can sign up in the same flow.
2

Review and generate a key

Kyara explains what an API key is for and which app requested it, then the user generates one. The key is shown once for the user to copy. Each run of the flow creates an additional key; existing keys keep working until the user regenerates from the dashboard, which revokes all of them. If the user has no active subscription and no top-up credits, the key is still created but requests with it return 403 no_active_plan until they subscribe.
3

Return to your app

The user is redirected to the redirect URL you provided. The key is not appended to the redirect, so the user pastes the copied key into your app to finish connecting.
The redirect value must be a valid HTTP or HTTPS URL. Kyara shows the destination domain to the user before sending them back, giving them full visibility into where they are being redirected.
Link users directly to this onboarding URL from your app’s settings or onboarding flow. It handles sign-up and key creation in one step, with no manual dashboard navigation.