Managing Secrets and Variables
Sparkabl Secrets Management UI Documentation
The Sparkable Secrets Management UI provides a secure way for users to manage their secrets or sensitive variables without exposing them to the AI or via shared urls. It allows users to add, view, and remove secrets used in your Sparkable applications.
How It Works
When defined, secrets are made available to your applications as environment variables
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${process.env.REACT_APP_OPENAI_API_KEY}`
},
Sparkable prioritizes the use of these keys when performing specific tasks. For example, if a user asks Sparkable to create a chat with a specific tool, it will use the relevant keys stored in the secrets management panel.
Secret Keys and Security
When sending your messages to Spark, the system only sends the key names, never their values. This ensures that the actual secret values remain secure and are not transmitted over the network.
Since the secrets are stored locally, they are not accessible from other machines or users. This ensures that sensitive information remains secure and private.
Keys are not saved to any external database or server.
If a project is shared, the keys will not be available in the shared URL and will need to be manually added by the new user.
Accessing the Secrets Management UI
To open the Secrets Management UI, simply click on the top right cog ⚙️ icon in the Sparkable UI top nav. The secrets management panel provides a list all secrets that have been added on your machine.
Secrets Naming
When adding new secrets, a specific naming conventions must be followed:
All secret names must start with
REACT_APP_.Any secret that does not follow this naming convention will not be accepted by the system.
Editing Secrets
Currently, the UI does not support the direct editing of existing secrets. Users must remove the old secret and add a new one if changes are needed.
Last updated