Skip to Content
LYNKORIADocs

Projects and API keys

Set up a project and environment in the console, then issue, rotate and revoke API keys.

You need the owner or admin console role to create projects and keys. Developers and auditors can view them. See the console for roles.

Create a project

  1. In the console, open Projects and select New project.
  2. Enter a display name. The slug is generated from it; it must start with a letter and contain only lowercase letters, digits and dashes. The slug cannot be changed later.
  3. Select Create project. You land on the project’s Environments tab.

Add an environment

Select Add environment, choose staging or production, and enter the LiveKit key reference your platform team configured for this product (for example vibelynk:staging). Each project has at most one environment of each kind.

Then configure it and select Save changes:

SettingWhat to set
Allowed originsEvery exact browser origin of your app, one per line, such as https://app.example.com. Native apps that send no Origin header are not affected.
FeaturesCalls, livestreaming, messaging, presence, attachments and single-device calls. Enable only what you use.
QuotasMax room size (2–1000), concurrent rooms, and tokens per minute. Requests beyond a quota fail with quota_exceeded.
Messaging policyWhether DMs, groups, threads, reactions and attachments are allowed, and an optional retention period in days.
WebhooksAn endpoint URL and a signing secret. See webhooks.

Saving only changes the fields you edited; other settings are kept.

Create an API key

  1. Open the project’s API keys tab and select Create key.
  2. Choose the environment. Staging keys start with lynk_test_, production keys with lynk_live_.
  3. Name the key after the deployment that will hold it, such as acme-backend-prod.
  4. Choose scopes:
ScopeAllows
calls:writeCreate, read and end calls; issue join tokens; moderate; send call signals.
messaging:writeIssue messaging tokens; create conversations; manage members.
users:writeSuspend and unsuspend users.
  1. Optionally set an expiry date.
  2. Copy the secret into your backend’s secret manager. It is shown only once; Lynkoria stores only a one-way digest.

Send it as a bearer token. The server SDK does this for you:

Authorization: Bearer lynk_live_…

Never put a service key in frontend code, VITE_* or NEXT_PUBLIC_* variables, a mobile app bundle, a URL, a screenshot or a support ticket. Anyone holding it can act as your backend for the whole environment, across every tenant.

Rotate a key

  1. Select Rotate on the key. A replacement with the same scopes is created and shown once. Both keys keep working.
  2. Deploy the new secret to your backend.
  3. Open the old key and confirm its Last used time stops advancing. Last use is recorded with a delay of about 15 seconds.
  4. Revoke the old key.

Expired keys cannot be rotated; create a new one instead.

Revoke a key

Select Revoke and type the key name to confirm. The next request using it fails with unauthorized. Tokens it already issued stay valid until they expire: up to 10 minutes for messaging and 5 minutes for joining calls. To cut off media immediately, remove participants or end the call. If a key was exposed, revoke it right away and review the project’s Activity tab.

Key details

Select a key to see its scopes, environment, creator, creation and expiry dates, last use, and its change history from the audit log. Lynkoria records when a key was last used, not request volume per key; project-level request counts are on the Analytics tab.

On this page