Runtime Clients

Generate and manage Client ID and Secret Key credentials for your visual

Runtime Client credentials authenticate your visual against the xRLive backend during a live show. Each visual gets its own Runtime API Credentials — a clientId and clientSecret pair your backend or visual uses to call the Runtime API.

Creating runtime credentials from My Library

The dashboard generates credentials — it never runs runtime events directly. Your visual or backend team uses them to authenticate, start events, and manage audience sessions.

Open Runtime API Credentials

1. Find your visual in My Library

   Go to My Library in the dashboard sidebar and locate the visual you want to configure.

2. Open Settings

   Click the ⋯ menu on the visual card and select Settings. The Runtime API Credentials window opens for that visual.

   

   Visual card menu — open Settings to manage runtime credentials

Create credentials

1. Name your credentials

   In the Create Runtime Client Credentials section, enter a Client name (for example, My first visual credentials). This label helps you tell credential sets apart if you rotate them later.

   

   Runtime API Credentials window before creating a client

2. Create and copy your keys

   Click Create credentials. A Created confirmation toast appears — Runtime credentials generated. Copy and store the secret now.

   The Existing Credentials section shows three values:

   • Visual ID — the UUID for this visual.
   • Client ID — the public identifier for authentication.
   • Secret Key — the private secret, shown once at creation.

   Use the Copy button next to each field to copy the values.

   

   Credentials generated — Visual ID, Client ID, and Secret Key ready to copy

   The Secret Key is shown once at creation. Copy and store it securely before closing the window. If you lose it, use Re-generate secret to create a new one.

3. Confirm and close

   Check I copied and securely stored this secret, then click Close.

   Never expose the clientSecret in frontend code. Embed credentials in your visual’s backend config or a secure data asset — see Runtime Client Credentials for SDK integration.

Manage existing credentials

From the same Runtime API Credentials window you can:

• Re-generate secret — creates a new Secret Key and invalidates the old one. The Client ID stays the same.
• Delete — permanently removes the credential set. Any visual or backend using it will get authentication errors until you create new credentials.

When creating a new set, you can check Delete existing active credentials before creating a new one to replace the current credentials in one step.

Where to go next

Runtime Client Credentials

Embed credentials in your visual and wire up the Runtime API.

Runtime API

Authenticate, start events, join sessions, and end events.