Integration Overview
Javelin offers configuration options to setup Large Language Models(LLMs) API Keys. You can easily setup virtual keys for all the providers. This will enable all your applications across your enterprise access all of your providers with just Javelin API Key.
Secret Object
When represented as json, the provider object has the following structure:
{
"api_key": "unique key for the secret",
"api_key_secret_name": "name for the secret",
"api_key_secret_key": "API key from the provider",
"api_key_secret_key_javelin": "Virtual API key generated by Javelin service",
"provider_name": "openai",
"query_param_key": "",
"header_key": "",
"group": "sales",
"enabled": true
}
Secret Fields
These configuration settings are all defined per secret
, they are not global and are applied individually on each route.
Field | Description |
---|---|
api_key | A unique identifier assigned to the API secret. This key is used to reference the secret within your system or codebase, ensuring that the actual sensitive values are not exposed |
api_key_secret_name | The descriptive name given to the secret. This name helps users and administrators identify the purpose or association of the secret, such as which service or API it is used for |
api_key_secret_key | The actual secret key or token provided by the provider. This is the sensitive piece of information that grants access to the API and should be protected accordingly |
api_key_secret_key_javelin | A virtual API key that represents the original secret within a secure environment like Javelin. This abstraction layer enhances security by minimizing direct exposure of the actual secret key |
provider_name | Identifies the provider or platform to which the secret pertains. This clarifies the context in which the secret is used, aiding in its management and application |
query_param_key | The key name for passing the secret as a query parameter in API requests. This is relevant for APIs that authenticate requests through parameters rather than headers |
header_key | The key name for sending the secret within the request header. Many APIs prefer header-based authentication as it keeps the secret out of the URL |
group | A categorization tool that groups related secrets together. This can be used to organize secrets by team, project, environment, or any other logical grouping, facilitating easier management and access control |
enabled | Indicates whether the secret is currently active and can be used for API access. This boolean field allows for the quick enabling or disabling of secrets without removing their configuration, useful for managing temporary access or rotating keys |