Issue a key¶
A Vidai key is the one thing a program holds. It says who's calling, which team pays, which environment it's in, which models it may call and how fast. The provider's own keys stay with Vidai, so nothing in your apps can leak them, and a key can be stopped in seconds without touching any app's provider settings.
Before you start¶
- Anyone in a team issues keys for themselves. Group admins issue for people and agents in their teams, an agent's owners for that agent, organisation admins for anyone.
- Each environment says who may issue keys there. The default environment is ready for everyone from the start.
- Organisation viewers don't hold keys: they look at the Control room and don't call models.
Steps¶
- Open Keys and choose Issue a key. (From a person's or agent's Keys tab, choose Issue a key for ….)
- For: Myself, A person or An agent, if you may issue for others. Pick who by name.
- Name: what uses it, so you can tell keys apart (up to 120 characters).
- Acts for: for a person in several teams, the team that pays for its calls and whose models apply. With one team it's chosen ("Acts for Research, your only team."). For an agent, optionally the Application it acts for.
- Environment: only the ones you may issue this key in are offered. The others are listed under Environments not available, each with its rule.
- Optionally:
- Expires on: the end of that day in your time zone, within the environment's longest key life (the field says the latest day).
- Rate limit, requests a minute: blank follows the default for its kind of key. Only an admin over the key can set more than the default.
- Only some models: narrow it below what its team or agent may call.
- Organisation admins: Translation between API formats (see below).
- Choose Issue key.
- Copy the secret. It's shown only this once. The dialog stays open until you choose Done, so a stray click can't lose it.
Check it worked¶
The key is listed as Active, showing only how it starts (vk_abcd…wxyz). Its detail says what it acts for, its
environment, the models it may call and whether the gateway has it (On the gateway). A change reaches the gateway
within seconds.
Give the secret to the program, and the base URL from Connect your app at the top of Keys.
If something's off¶
- Calls nothing: what it acts for allows no models, or you narrowed it to none. It's issued anyway; choose models for it, or for its team or agent, before it's used.
- The environment you want isn't offered: ask an organisation admin to issue it there, or to change who may issue on Environments.
- The expiry is refused: it must be after today and within the environment's longest key life.
Translation between API formats¶
When an app speaks one provider's format and the model sits behind another, the gateway translates. A key says how:
- Standard: the gateway's usual translation. Every key starts here.
- Keep what the other format can't say: carries over what the other format has no field for, where it can. For apps that rely on a provider's own options.
- Let apps choose the translation per call: an app may ask for the other translation on a single call. Off by default.
Good to know¶
- What a key acts for decides who pays. Each call keeps who paid when it was made; changing the key later never moves past calls.
- A key holder, or an agent's owner, can give a key a lower rate limit than the default; only an admin over the key may set a higher one. The gateway counts requests a minute, not tokens.
- Vidai revokes a key within seconds of its expiry; it then reads Expired.