Manage API keys

You can provide your API key directly in the agentgateway configuration. This option is the least secure. Only use this option for quick tests.

1. Configure the agentgateway proxy and enter your key in the params.apiKey field directly.

   cat <<EOF > config.yaml
   # yaml-language-server: $schema=https://agentgateway.dev/schema/config
   llm:
     models:
     - name: "*"
       provider: openAI
       params:
         apiKey: "sk-proj...."
   EOF

1. Get the token from your LLM provider, such as an API key to OpenAI and save it as an environment variable.

   export OPENAI_API_KEY=<your-api-key>

2. Configure the agentgateway proxy to refer to that environment variable. Agentgateway automatically replaces the value of the variable with the value that is stored in the environment.

   cat <<'EOF' > config.yaml
   # yaml-language-server: $schema=https://agentgateway.dev/schema/config
   llm:
     models:
     - name: "*"
       provider: openAI
       params:
         apiKey: "$OPENAI_API_KEY"
   EOF

You can store your API key in a file and load the file into agentgateway during startup.

1. Save your API key in a file, such as key.txt.

   echo "<your-apikey>" >> key.txt

2. Load the key from the file into an environment variable and configure the agentgateway proxy.

   export OPENAI_API_KEY=$(cat key.txt)

   cat <<'EOF' > config.yaml
   # yaml-language-server: $schema=https://agentgateway.dev/schema/config
   llm:
     models:
     - name: "*"
       provider: openAI
       params:
         apiKey: "$OPENAI_API_KEY"
   EOF

When deploying agentgateway on Kubernetes, you can leverage Kubernetes secrets to store your API key or pass through a token by using an Authorization or other custom header.

For more information, see the agentgateway on Kubernetes docs.