Send API key via x-goog-api-key header, not URL query

Refactor all Gemini API functions to send the API key using the x-goog-api-key HTTP header instead of as a URL query parameter. Update documentation and Rd files to reflect this change. Remove all uses of req_url_query for API key transmission and update httr2 import statements accordingly.

Author: jhk0530

NAMESPACE

@@ -42,7 +42,6 @@ importFrom(httr2,req_headers)
 importFrom(httr2,req_method)
 importFrom(httr2,req_perform)
 importFrom(httr2,req_timeout)
-importFrom(httr2,req_url_query)
 importFrom(httr2,request)
 importFrom(httr2,resp_body_json)
 importFrom(httr2,resp_body_string)

R/gemini.R

@@ -22,7 +22,7 @@
 #' setAPI("YOUR_API_KEY")
 #' gemini("Explain dplyr's mutate function")
 #' }
-#' @importFrom httr2 request req_url_query req_headers req_body_json req_perform resp_body_json req_timeout
+#' @importFrom httr2 request req_headers req_body_json req_perform resp_body_json req_timeout
 #' @importFrom cli cli_status_clear cli_status
 #'
 #' @seealso https://ai.google.dev/docs/gemini_api_overview#text_input
@@ -53,7 +53,7 @@ gemini <- function(prompt, model = "2.0-flash", temperature = 1, maxOutputTokens
   if (model == "2.0-flash-exp-image-generation") {
     generation_config$responseModalities <- list("Text", "Image")
   }
-  
+
   # Create request body as a separate list
   request_body <- list(
     contents = list(
@@ -66,12 +66,14 @@ gemini <- function(prompt, model = "2.0-flash", temperature = 1, maxOutputTokens
 
   # Set timeout using req_timeout
   req <- request(url) |>
-    req_url_query(key = api_key) |>
-    req_headers("Content-Type" = "application/json") |>
+    req_headers(
+      "x-goog-api-key" = api_key,
+      "Content-Type" = "application/json"
+    ) |>
     req_body_json(request_body) |>
     req_timeout(as.integer(timeout))
   resp <- req_perform(req)
-  
+
   # Add logic to check status code
   if (resp$status_code != 200) {
     cli_status_clear(id = sb)
@@ -133,7 +135,7 @@ gemini.vertex <- function(prompt = NULL, tokens = NULL, temperature = 1, maxOutp
     topK = topK,
     seed = seed
   )
-  
+
   # Create request body as a separate list
   request_body <- list(
     contents = list(
@@ -155,22 +157,22 @@ gemini.vertex <- function(prompt = NULL, tokens = NULL, temperature = 1, maxOutp
     ) |>
     req_body_json(request_body) |>
     req_timeout(as.integer(timeout))
-  
+
   resp <- req_perform(req)
-  
+
   # Add logic to check status code
   if (resp$status_code != 200) {
     cli_status_clear(id = sb)
     cli_alert_danger(paste0("Error in generate request: Status code ", resp$status_code))
     return(NULL)
   }
-  
+
   response <- resp_body_json(resp)
 
   cli_status_clear(id = sb)
-  
+
   candidates <- response$candidates
   outputs <- unlist(lapply(candidates, function(candidate) candidate$content$parts))
-  
+
   return(outputs)
 }

R/gemini_audio.R

@@ -16,6 +16,9 @@
 #' @param seed The seed to use. Default is 1234 value should be integer
 #'              see https://ai.google.dev/gemini-api/docs/models/generative-models#model-parameters
 #'
+#' @details
+#' The API key is now sent via the HTTP header \code{x-goog-api-key} instead of as a URL query parameter.
+#'
 #' @return A character vector containing the Gemini API's response.
 #'
 #' @export
@@ -29,7 +32,7 @@
 #'
 #' @importFrom tools file_ext
 #' @importFrom cli cli_alert_danger cli_status cli_status_clear cli_alert_warning cli_alert_info
-#' @importFrom httr2 request req_url_query req_headers req_body_json req_perform resp_body_json req_method req_body_file resp_header
+#' @importFrom httr2 request req_headers req_body_json req_perform resp_body_json req_method req_body_file resp_header
 #'
 #'
 gemini_audio <- function(audio = NULL, prompt = "Describe this audio", model = "2.0-flash",
@@ -51,16 +54,18 @@ gemini_audio <- function(audio = NULL, prompt = "Describe this audio", model = "
 
   ext <- tolower(tools::file_ext(audio))
 
-  if(ext == ""){
+  if (ext == "") {
     cli_alert_warning("File extension not found. Please check the file path.")
     return(NULL)
   }
 
   # 2. Error handling for unsupported file extensions
   supported_extensions <- c("mp3", "wav", "aiff", "aac", "ogg", "flac")
   if (!(ext %in% supported_extensions)) {
-    cli_alert_danger(paste0("Unsupported file extension: '", ext, "'. Currently supported extensions are: ", 
-                          paste(supported_extensions, collapse=", ")))
+    cli_alert_danger(paste0(
+      "Unsupported file extension: '", ext, "'. Currently supported extensions are: ",
+      paste(supported_extensions, collapse = ", ")
+    ))
     cli_alert_info("Please submit an issue at https://github.com/jhk0530/gemini.R/issues for additional file format support.")
     return(NULL)
   }
@@ -70,18 +75,18 @@ gemini_audio <- function(audio = NULL, prompt = "Describe this audio", model = "
 
   # Special case override: not defined yet
   # special_cases <- list(mp3 = "audio/mpeg")
-  #if (!is.null(special_cases[[ext]])) {
+  # if (!is.null(special_cases[[ext]])) {
   #  mime_type <- special_cases[[ext]]
-  #}
-  
+  # }
+
   num_bytes <- file.info(audio)$size
 
   # Prepare file upload
   resumable_request <-
     request(file_url) |>
-    req_url_query(key = api_key) |>
     req_method("POST") |>
     req_headers(
+      "x-goog-api-key" = api_key,
       "X-Goog-Upload-Protocol" = "resumable",
       "X-Goog-Upload-Command" = "start",
       "X-Goog-Upload-Header-Content-Length" = as.character(num_bytes),
@@ -129,7 +134,7 @@ gemini_audio <- function(audio = NULL, prompt = "Describe this audio", model = "
 
   # Add this line to define model_query
   model_query <- paste0("gemini-", model, ":generateContent")
-  
+
   url <- paste0("https://generativelanguage.googleapis.com/v1beta/models/", model_query)
 
   sb <- cli_status("Gemini is analyzing audio...")
@@ -142,7 +147,7 @@ gemini_audio <- function(audio = NULL, prompt = "Describe this audio", model = "
     topK = topK,
     seed = seed
   )
-  
+
   # Compose request body as a separate list
   request_body <- list(
     contents = list(
@@ -155,9 +160,11 @@ gemini_audio <- function(audio = NULL, prompt = "Describe this audio", model = "
   )
 
   generate_req <- request(url) |>
-    req_url_query(key = api_key) |>
     req_method("POST") |>
-    req_headers("Content-Type" = "application/json") |>
+    req_headers(
+      "x-goog-api-key" = api_key,
+      "Content-Type" = "application/json"
+    ) |>
     req_body_json(request_body)
 
   generate_resp <- req_perform(generate_req)
@@ -224,7 +231,7 @@ gemini_audio.vertex <- function(audio = NULL, prompt = "Describe this audio", to
     topK = topK,
     seed = seed
   )
-  
+
   # Compose request body as a separate list
   request_body <- list(
     contents = list(

R/gemini_chat.R

@@ -31,7 +31,7 @@
 #' chats <- gemini_chat("How do you think about summer?", chats$history)
 #' print(chats$outputs)
 #' }
-#' @importFrom httr2 request req_url_query req_headers req_body_json req_perform resp_body_json
+#' @importFrom httr2 request req_headers req_body_json req_perform resp_body_json
 #' @importFrom cli cli_alert_danger cli_status_clear cli_status
 #' @seealso https://ai.google.dev/docs/gemini_api_overview#chat
 #'
@@ -51,7 +51,7 @@ gemini_chat <- function(prompt, history = list(), model = "2.0-flash", temperatu
   api_key <- Sys.getenv("GEMINI_API_KEY")
 
   sb <- cli_status("Gemini is answering...")
-  
+
   # 2. Create generation_config as a separate list
   generation_config <- list(
     temperature = temperature,
@@ -60,32 +60,34 @@ gemini_chat <- function(prompt, history = list(), model = "2.0-flash", temperatu
     topK = topK,
     seed = seed
   )
-  
+
   # Create request body as a separate variable
   request_body <- list(
     contents = history,
     generationConfig = generation_config
   )
-  
+
   req <- request(url) |>
-    req_url_query(key = api_key) |>
-    req_headers("Content-Type" = "application/json") |>
+    req_headers(
+      "x-goog-api-key" = api_key,
+      "Content-Type" = "application/json"
+    ) |>
     req_body_json(request_body)
 
   resp <- req_perform(req)
-  
+
   # 3. Add status code validation
   if (resp$status_code != 200) {
     cli_status_clear(id = sb)
     cli_alert_danger(paste0("Error in generate request: Status code ", resp$status_code))
     return(NULL)
   }
-  
+
   cli_status_clear(id = sb)
 
   candidates <- resp_body_json(resp)$candidates
   outputs <- unlist(lapply(candidates, function(candidate) candidate$content$parts))
-  
+
   # 4. Improve response handling - handle multiple responses
   if (length(outputs) > 0) {
     # Record the first response
@@ -116,14 +118,14 @@ addHistory <- function(history, role = NULL, item = NULL) {
     cli_alert_danger("{.arg item} must not be NULL")
     return(NULL)
   }
-  
+
   # Add role validation
   valid_roles <- c("user", "model")
   if (!(role %in% valid_roles)) {
-    cli_alert_danger(paste0("Invalid role: '", role, "'. Must be one of: ", paste(valid_roles, collapse=", ")))
+    cli_alert_danger(paste0("Invalid role: '", role, "'. Must be one of: ", paste(valid_roles, collapse = ", ")))
     return(NULL)
   }
-  
+
   history[[length(history) + 1]] <-
     list(
       role = role,

R/gemini_docs.R

@@ -5,7 +5,7 @@
 #' @param pdf_path Path(s) to the local file(s). Can be a character vector.
 #' @param prompt The prompt to send to Gemini (e.g., "Summarize these documents").
 #' @param type File type. One of "PDF", "JavaScript", "Python", "TXT", "HTML", "CSS", "Markdown", "CSV", "XML", "RTF". Default is "PDF".
-#' @param api_key Gemini API key. Defaults to \code{Sys.getenv("GEMINI_API_KEY")}.
+#' @param api_key Gemini API key. Defaults to \code{Sys.getenv("GEMINI_API_KEY")}. The API key is sent via the HTTP header \code{x-goog-api-key}.
 #'
 #' @return The summary or response text from Gemini.
 #'
@@ -21,21 +21,21 @@
 #' )
 #' }
 #'
-#' @importFrom httr2 request req_url_query req_headers req_body_json req_perform resp_body_json
+#' @importFrom httr2 request req_headers req_body_json req_perform resp_body_json
 #' @importFrom base64enc base64encode
 #'
 #' @export
 #' @seealso https://ai.google.dev/gemini-api/docs/document-processing?lang=rest
 gemini_docs <- function(pdf_path, prompt, type = "PDF", api_key = Sys.getenv("GEMINI_API_KEY"), large = FALSE, local = FALSE) {
   # If local = FALSE and input is a URL, download to a temp file
   temp_files <- character(0)
-  if (!local) {    
+  if (!local) {
     # Download the file to a temp file
     temp_file <- tempfile(fileext = paste0(".", tools::file_ext(pdf_path)))
     download.file(pdf_path, temp_file, mode = "wb", quiet = TRUE)
     temp_files <- c(temp_files, temp_file)
     pdf_path <- temp_file
-      
+
     # Remove temp files on exit
     if (length(temp_files) > 0) on.exit(unlink(temp_files), add = TRUE)
   }
@@ -88,8 +88,10 @@ gemini_docs <- function(pdf_path, prompt, type = "PDF", api_key = Sys.getenv("GE
     url <- "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent"
 
     req <- httr2::request(url) |>
-      httr2::req_url_query(key = api_key) |>
-      httr2::req_headers("Content-Type" = "application/json") |>
+      httr2::req_headers(
+        "x-goog-api-key" = api_key,
+        "Content-Type" = "application/json"
+      ) |>
       httr2::req_body_json(body, auto_unbox = TRUE)
 
     resp <- httr2::req_perform(req)
@@ -130,8 +132,10 @@ gemini_docs <- function(pdf_path, prompt, type = "PDF", api_key = Sys.getenv("GE
     url <- "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.5-flash:generateContent"
 
     req <- httr2::request(url) |>
-      httr2::req_url_query(key = api_key) |>
-      httr2::req_headers("Content-Type" = "application/json") |>
+      httr2::req_headers(
+        "x-goog-api-key" = api_key,
+        "Content-Type" = "application/json"
+      ) |>
       httr2::req_body_json(body, auto_unbox = TRUE)
 
     resp <- httr2::req_perform(req)
@@ -183,7 +187,7 @@ gemini_docs <- function(pdf_path, prompt, type = "PDF", api_key = Sys.getenv("GE
 #' @seealso https://cloud.google.com/vertex-ai/docs/generative-ai/multimodal/send-request-document
 
 gemini_docs.vertex <- function(file_uri, prompt, mime_type = "application/pdf", tokens = NULL,
-                              temperature = 1, maxOutputTokens = 8192, topK = 40, topP = 0.95, seed = 1234) {
+                               temperature = 1, maxOutputTokens = 8192, topK = 40, topP = 0.95, seed = 1234) {
   # Validate input parameters
   if (missing(file_uri) || length(file_uri) < 1) {
     stop("At least one file_uri must be provided.")
@@ -253,8 +257,8 @@ upload_api <- function(local_file, api_key, mime_type) {
   file_size <- file.info(local_file)$size
   meta_body <- list(file = list(display_name = basename(local_file)))
   meta_req <- httr2::request("https://generativelanguage.googleapis.com/upload/v1beta/files") |>
-    httr2::req_url_query(key = api_key) |>
     httr2::req_headers(
+      "x-goog-api-key" = api_key,
       "X-Goog-Upload-Protocol" = "resumable",
       "X-Goog-Upload-Command" = "start",
       "X-Goog-Upload-Header-Content-Length" = as.character(file_size),
@@ -287,4 +291,4 @@ upload_api <- function(local_file, api_key, mime_type) {
   file_uri <- upload_result$file$uri
   if (is.null(file_uri)) stop("Failed to get file_uri after upload.")
   return(file_uri)
-}
+}