Skip to contents

Set or update your Azure AI Foundry API key for authentication. The key can be obtained from the Azure Portal under your Azure OpenAI resource.

Usage

foundry_set_key(key = NULL, store = FALSE)

Arguments

key

Character string containing your API key, or NULL to set interactively. If NULL in an interactive session, will prompt for input.

store

Logical. If TRUE, stores the key in .Renviron for future sessions. Default: FALSE (key only available for current session).

Value

Invisibly returns TRUE if key was set successfully.

Examples

if (FALSE) { # \dontrun{
# Set key for current session only
foundry_set_key("your-api-key-here")

# Set key interactively and store permanently
foundry_set_key(store = TRUE)
} # }