Skip to content

Provider Keys And Environment Variables

This page lists provider keys and public environment variable aliases for chat setup.

PackageProvider keyModel meansRequired or common environment variables
HPD-Agent.Providers.OpenAIopenaiOpenAI model idOPENAI_API_KEY; optional custom endpoint by convention: OPENAI_ENDPOINT
HPD-Agent.Providers.OpenAIazure-openaiAzure OpenAI deployment nameAZURE_OPENAI_ENDPOINT, AZURE_OPENAI_API_KEY
HPD-Agent.Providers.AzureAIazure-aiAzure AI Foundry/Projects or Azure OpenAI deployment nameAZURE_AI_ENDPOINT; AZURE_AI_API_KEY only when not using OAuth
HPD-Agent.Providers.AnthropicanthropicClaude model idANTHROPIC_API_KEY
HPD-Agent.Providers.CoherecohereCohere chat model id or embedding model idCOHERE_API_KEY
HPD-Agent.Providers.DashScopedashscopeDashScope/Qwen chat model id or embedding model idDASHSCOPE_API_KEY; aliases: QWEN_API_KEY, DASHSCOPE_KEY; set Endpoint or baseAddress for a custom base URL
HPD-Agent.Providers.CerebrascerebrasCerebras OpenAI-compatible chat model idCEREBRAS_API_KEY; optional endpoint aliases: CEREBRAS_ENDPOINT, CEREBRAS_BASE_URL
HPD-Agent.Providers.DeepSeekdeepseekDeepSeek OpenAI-compatible chat model idDEEPSEEK_API_KEY; optional endpoint aliases: DEEPSEEK_ENDPOINT, DEEPSEEK_BASE_URL
HPD-Agent.Providers.DeepInfradeepinfraDeepInfra OpenAI-compatible chat model idDEEPINFRA_API_KEY; optional endpoint aliases: DEEPINFRA_ENDPOINT, DEEPINFRA_BASE_URL
HPD-Agent.Providers.FireworksfireworksFireworks chat model idFIREWORKS_API_KEY; optional endpoint aliases: FIREWORKS_ENDPOINT, FIREWORKS_BASE_URL
HPD-Agent.Providers.SambaNovasambanovaSambaNova OpenAI-compatible chat model idSAMBANOVA_API_KEY; optional endpoint aliases: SAMBANOVA_ENDPOINT, SAMBANOVA_BASE_URL
HPD-Agent.Providers.HyperbolichyperbolicHyperbolic OpenAI-compatible chat model idHYPERBOLIC_API_KEY; optional endpoint aliases: HYPERBOLIC_ENDPOINT, HYPERBOLIC_BASE_URL
HPD-Agent.Providers.OVHcloudovhcloudOVHcloud AI Endpoints OpenAI-compatible chat model idOVHCLOUD_API_KEY; optional endpoint aliases: OVHCLOUD_ENDPOINT, OVHCLOUD_BASE_URL
HPD-Agent.Providers.NscalenscaleNscale OpenAI-compatible chat model idNSCALE_API_KEY; optional endpoint aliases: NSCALE_ENDPOINT, NSCALE_BASE_URL
HPD-Agent.Providers.VeniceveniceVenice.ai OpenAI-compatible chat model idVENICE_API_KEY; optional endpoint aliases: VENICE_ENDPOINT, VENICE_BASE_URL
HPD-Agent.Providers.PerplexityperplexityPerplexity Sonar chat model idPERPLEXITY_API_KEY; optional endpoint aliases: PERPLEXITY_ENDPOINT, PERPLEXITY_BASE_URL
HPD-Agent.Providers.LMStudiolmstudioLoaded LM Studio local model idNo API key required by default; optional aliases: LMSTUDIO_API_KEY, LM_STUDIO_API_KEY; endpoint aliases: LMSTUDIO_ENDPOINT, LMSTUDIO_BASE_URL, LMSTUDIO_API_BASE, LM_STUDIO_ENDPOINT, LM_STUDIO_BASE_URL, LM_STUDIO_API_BASE
HPD-Agent.Providers.NebiusnebiusNebius Token Factory chat model idNEBIUS_API_KEY; optional endpoint aliases: NEBIUS_ENDPOINT, NEBIUS_BASE_URL
HPD-Agent.Providers.NvidiaNimnvidia-nimNVIDIA NIM chat model idNVIDIA_API_KEY or NVIDIA_NIM_API_KEY; optional endpoint aliases: NVIDIA_NIM_ENDPOINT, NVIDIA_NIM_BASE_URL, NVIDIA_ENDPOINT, NVIDIA_BASE_URL
HPD-Agent.Providers.SiliconFlowsiliconflowSiliconFlow OpenAI-compatible chat model idSILICONFLOW_API_KEY; optional endpoint aliases: SILICONFLOW_ENDPOINT, SILICONFLOW_BASE_URL
HPD-Agent.Providers.ScalewayscalewayScaleway Generative APIs chat model idSCW_SECRET_KEY, SCALEWAY_API_KEY, or SCW_API_KEY; optional endpoint aliases: SCALEWAY_ENDPOINT, SCALEWAY_BASE_URL, SCW_ENDPOINT, SCW_BASE_URL
HPD-Agent.Providers.ZaizaiZ.AI chat model idZAI_API_KEY, Z_AI_API_KEY, or BIGMODEL_API_KEY; optional endpoint aliases: ZAI_ENDPOINT, ZAI_BASE_URL, Z_AI_ENDPOINT, Z_AI_BASE_URL, BIGMODEL_ENDPOINT, BIGMODEL_BASE_URL
HPD-Agent.Providers.MiniMaxminimaxMiniMax chat model idMINIMAX_API_KEY; optional endpoint aliases: MINIMAX_ENDPOINT, MINIMAX_BASE_URL, MINIMAX_API_BASE
HPD-Agent.Providers.TogethertogetherTogether chat model id or embedding model idTOGETHER_API_KEY; set Endpoint for a custom base URL
HPD-Agent.Providers.XaixaixAI chat model idXAI_API_KEY; optional endpoint aliases: XAI_ENDPOINT, XAI_BASE_URL
HPD-Agent.Providers.GroqgroqGroq chat model idGROQ_API_KEY; optional endpoint alias: GROQ_ENDPOINT
HPD-Agent.Providers.MoonshotmoonshotMoonshot/Kimi chat model idMOONSHOT_API_KEY; alias: KIMI_API_KEY; optional endpoint aliases: MOONSHOT_ENDPOINT, MOONSHOT_BASE_URL, KIMI_ENDPOINT, KIMI_BASE_URL
HPD-Agent.Providers.ReplicatereplicateReplicate image model id in owner/model formatREPLICATE_API_KEY or REPLICATE_API_TOKEN
HPD-Agent.Providers.GoogleAIgoogle-aiGemini model idregistered aliases: GOOGLE_API_KEY, GEMINI_API_KEY, or GOOGLE_AI_API_KEY
HPD-Agent.Providers.OllamaollamaLocal Ollama model tagFluent setup can read OLLAMA_ENDPOINT or OLLAMA_HOST; JSON/config should set Endpoint when not using localhost
HPD-Agent.Providers.HuggingFacehuggingfaceHugging Face repository idHUGGINGFACE_API_KEY or HF_TOKEN
HPD-Agent.Providers.MistralmistralMistral model idMISTRAL_API_KEY
HPD-Agent.Providers.BedrockbedrockAmazon Bedrock model idAWS_REGION or AWS_DEFAULT_REGION; credentials usually come from the AWS SDK default credential chain
HPD-Agent.Providers.OnnxRuntimeonnx-runtimeLocal ONNX Runtime GenAI model directoryONNX_MODEL_PATH for provider-config setup
HPD-Agent.Providers.Audio.OpenAIopenaiAudio model id for STT/TTS/realtime familiesOPENAI_API_KEY; optional endpoint aliases: OPENAI_ENDPOINT, OPENAI_BASE_URL
HPD-Agent.Providers.Audio.ElevenLabselevenlabsElevenLabs STT/TTS model or voice setupELEVENLABS_API_KEY
HPD-Agent.Providers.OpenRouteropenrouterOpenRouter model idNo fluent AgentBuilder helper in the current package; OPENROUTER_API_KEY

Configuration Keys

When configuration is available, the default resolver checks provider-scoped keys. Prefer exact provider keys:

text
openai:ApiKey
Providers:openai:ApiKey
azure-openai:Endpoint
Providers:azure-openai:Endpoint

Explicit values in ClientProviderConfig or fluent setup take precedence over resolver lookup.

Bedrock credential env variables such as AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN are accepted by the AWS SDK default credential chain and are also registered as bedrock:* aliases. bedrock:Region resolves AWS_REGION and AWS_DEFAULT_REGION.

Live Smoke Gates

Live provider smokes are opt-in so ordinary test runs do not spend provider quota or require local model assets.

SmokeRequired variables
OpenAI text-to-speechHPD_AUDIO_LIVE_SMOKE=1, OPENAI_API_KEY
OpenAI realtime agent turnHPD_REALTIME_LIVE_SMOKE=1, OPENAI_API_KEY
ElevenLabs text-to-speechHPD_AUDIO_LIVE_SMOKE=1, ELEVENLABS_API_KEY
ElevenLabs realtime speech-to-textELEVENLABS_API_KEY and a caller/test that sends PCM audio through the STT streaming path
ONNX Runtime local inferenceONNX_MODEL_PATH

Azure Terms

Use precise Azure wording:

  • azure-openai is the traditional Azure OpenAI resource path. Its ModelName is a deployment name, and setup requires an endpoint and API key.
  • azure-ai is the current Azure AI Projects / Foundry path. It also supports traditional Azure OpenAI endpoints. Foundry/Projects endpoints use services.ai.azure.com with /api/projects/ and require OAuth; passing an API key for that endpoint shape is invalid. AuthMode.Auto uses an API key when one is configured and otherwise falls back to DefaultAzureCredential.

Setup Caveat

Some providers validate ApiKey, Endpoint, or Region before deferred secret resolution. Keep provider setup examples explicit when you need self-contained configuration, and use environment aliases when deployment configuration owns the secret values.

Built for production .NET agent applications.