Skip to main content

Multiplayer API Key

The Multiplayer API key authenticates your application when sending session recording data to Multiplayer. Without it, we can’t associate your frontend or backend data with your project. The API key ensures that session recordings, traces, logs, and other data are securely tied to your account.

Overview​

There are two types of API keys:

  • Project API keys: API keys to authenticate the Multiplayer CLI when OAuth is not available or not preferred.
  • Session recorder API keys: API keys to authenticate your application when sending session data to Multiplayer.

When following the Multiplayer quickstart, the API keys are automatically generated.

You can review your API keys in the Multiplayer web dashboard:

  • "Agents" tab > "API keys" button
  • "Settings"

Both paths open the project settings where you can view the "API keys" and "Session Recorder" tabs.

Manual API key generation​

You'll need to manually create an API key IF:

How to generate it​

Login into your Multiplayer account. If you don't already have one, create a free trial at go.multiplayer.app.

Navigate to:

  • "Agents" tab > "API keys" or "Settings" to open the project settings
  • In "API keys" create an API key to authenticate the Multiplayer CLI. Copy the key immediately. For security reasons, you won’t be able to view it again later. If you lose it, you’ll need to generate a new one.
  • In "Session Recorder" create an API key to authenticate your application when sending session data to Multiplayer. Copy the key immediately. For security reasons, you won’t be able to view it again later. If you lose it, you’ll need to generate a new one.

Best practices​

  • Use environment variables: Store your API key(s) in your deployment environment, not in your code repository.

  • Rotate periodically: Regenerate keys if you suspect compromise or want to enforce rotation policies.

You did it! What’s next?​

🚀 If you’re ready to trial Multiplayer with your own app, you can follow the steps in the quickstart.

If you have any questions or trouble with the configuration, contact us.