> For the complete documentation index, see [llms.txt](https://developers.oxylabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.oxylabs.io/api-targets/llms-and-ai/gemini.md). # Gemini The `gemini` source lets you submit a prompt to Google Gemini and receive a parsed, structured response, including the plain text and Markdown answers. ## Request samples The following code examples show how to submit a prompt and retrieve a Gemini response with parsed results. {% tabs %} {% tab title="cURL" %} ```bash curl 'https://realtime.oxylabs.io/v1/queries' \ --user 'USERNAME:PASSWORD' \ -H 'Content-Type: application/json' \ -d '{ "source": "gemini", "prompt": "best supplements for better sleep", "parse": true, "geo_location": "United States" }' ``` {% endtab %} {% tab title="Python" %} ```python import requests from pprint import pprint # Structure payload. payload = { 'source': 'gemini', 'prompt': 'best supplements for better sleep', 'parse': True, 'geo_location': "United States" } # Get response. response = requests.request( 'POST', 'https://realtime.oxylabs.io/v1/queries', auth=('USERNAME', 'PASSWORD'), json=payload, ) # Print prettified response to stdout. pprint(response.json()) ``` {% endtab %} {% tab title="Node.js" %} ```js const https = require("https"); const username = "USERNAME"; const password = "PASSWORD"; const body = { source: "gemini", prompt: "best supplements for better sleep", parse: true, geo_location: "United States" }; const options = { hostname: "realtime.oxylabs.io", path: "/v1/queries", method: "POST", headers: { "Content-Type": "application/json", Authorization: "Basic " + Buffer.from(`${username}:${password}`).toString("base64"), }, }; const request = https.request(options, (response) => { let data = ""; response.on("data", (chunk) => { data += chunk; }); response.on("end", () => { const responseData = JSON.parse(data); console.log(JSON.stringify(responseData, null, 2)); }); }); request.on("error", (error) => { console.error("Error:", error); }); request.write(JSON.stringify(body)); request.end(); ``` {% endtab %} {% tab title="URL" %} ``` https://realtime.oxylabs.io/v1/queries?source=gemini&prompt=best%20supplements%20for%20better%20sleep&parse=true&geo_location=United%20States&access_token=12345abcde ``` {% endtab %} {% tab title="PHP" %} ```php 'gemini', 'prompt' => 'best supplements for better sleep', 'parse' => true, 'geo_location' => "United States" ); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://realtime.oxylabs.io/v1/queries"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params)); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_USERPWD, "USERNAME" . ":" . "PASSWORD"); $headers = array(); $headers[] = "Content-Type: application/json"; curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $result = curl_exec($ch); echo $result; if (curl_errno($ch)) { echo 'Error:' . curl_error($ch); } curl_close($ch); ``` {% endtab %} {% tab title="Go" %} ```go package main import ( "bytes" "encoding/json" "fmt" "io/ioutil" "net/http" ) func main() { const Username = "USERNAME" const Password = "PASSWORD" payload := map[string]interface{}{ "source": "gemini", "prompt": "best supplements for better sleep", "parse": true, "geo_location": "United States", } jsonValue, _ := json.Marshal(payload) client := &http.Client{} request, _ := http.NewRequest("POST", "https://realtime.oxylabs.io/v1/queries", bytes.NewBuffer(jsonValue), ) request.SetBasicAuth(Username, Password) response, _ := client.Do(request) responseText, _ := ioutil.ReadAll(response.Body) fmt.Println(string(responseText)) } ``` {% endtab %} {% tab title="C#" %} ```csharp using System; using System.Collections.Generic; using System.Net.Http; using System.Net.Http.Json; using System.Threading.Tasks; namespace OxyApi { class Program { static async Task Main() { const string Username = "USERNAME"; const string Password = "PASSWORD"; var parameters = new { source = "gemini", prompt = "best supplements for better sleep", parse = true, geo_location = "United States" }; var client = new HttpClient(); Uri baseUri = new Uri("https://realtime.oxylabs.io"); client.BaseAddress = baseUri; var requestMessage = new HttpRequestMessage(HttpMethod.Post, "/v1/queries"); requestMessage.Content = JsonContent.Create(parameters); var authenticationString = $"{Username}:{Password}"; var base64EncodedAuthenticationString = Convert.ToBase64String(System.Text.ASCIIEncoding.UTF8.GetBytes(authenticationString)); requestMessage.Headers.Add("Authorization", "Basic " + base64EncodedAuthenticationString); var response = await client.SendAsync(requestMessage); var contents = await response.Content.ReadAsStringAsync(); Console.WriteLine(contents); } } } ``` {% endtab %} {% tab title="Java" %} ```java package org.example; import okhttp3.*; import org.json.JSONObject; import java.util.concurrent.TimeUnit; public class Main implements Runnable { private static final String AUTHORIZATION_HEADER = "Authorization"; public static final String USERNAME = "USERNAME"; public static final String PASSWORD = "PASSWORD"; public void run() { JSONObject jsonObject = new JSONObject(); jsonObject.put("source", "gemini"); jsonObject.put("prompt", "best supplements for better sleep"); jsonObject.put("parse", true); jsonObject.put("geo_location", "United States"); Authenticator authenticator = (route, response) -> { String credential = Credentials.basic(USERNAME, PASSWORD); return response .request() .newBuilder() .header(AUTHORIZATION_HEADER, credential) .build(); }; var client = new OkHttpClient.Builder() .authenticator(authenticator) .readTimeout(180, TimeUnit.SECONDS) .build(); var mediaType = MediaType.parse("application/json; charset=utf-8"); var body = RequestBody.create(jsonObject.toString(), mediaType); var request = new Request.Builder() .url("https://realtime.oxylabs.io/v1/queries") .post(body) .build(); try (var response = client.newCall(request).execute()) { if (response.body() != null) { try (var responseBody = response.body()) { System.out.println(responseBody.string()); } } } catch (Exception exception) { System.out.println("Error: " + exception.getMessage()); } System.exit(0); } public static void main(String[] args) { new Thread(new Main()).start(); } } ``` {% endtab %} {% tab title="JSON" %} ```json { "source": "gemini", "prompt": "best supplements for better sleep", "parse": true, "geo_location": "United States" } ``` {% endtab %} {% endtabs %} {% hint style="info" %} **Note:** JavaScript rendering is enabled by default for all LLM sources. You do not need to include rendering parameters in your request payload. {% endhint %} We use synchronous [**Realtime**](/products/web-scraper-api/integration-methods/realtime.md) integration method in our examples. If you would like to use [**Proxy Endpoint**](/products/web-scraper-api/integration-methods/proxy-endpoint.md) or asynchronous [**Push-Pull**](/products/web-scraper-api/integration-methods/push-pull.md) integration, refer to the [**integration methods**](/products/web-scraper-api/integration-methods.md) section. {% hint style="warning" %} B**atch requests** are currently **not supported** for the `gemini` source. {% endhint %} ### Request parameters Basic setup and customization options for scraping Gemini.
ParameterDescriptionDefault Value
sourceSets the scraper target. Use gemini.–
promptThe prompt or question to submit to Gemini. Must be under 8000 characters.–
parseSet to true for structured JSON data.false
geo_locationSpecify a country to route the request from. More info.–
callback_urlURL to your callback endpoint. More info–
\- mandatory parameter ## Structured data Web Scraper API is capable of extracting a JSON object that contains Gemini output, offering structured data on various elements of the results page.
gemini structured output ```json { "results": [ { "job_id": "7470031540181837825", "status_code": 200, "url": "https://gemini.google.com/app/ca6b069d5af5c809", "content": { "prompt": "best supplements for better sleep", "response_text": "If you are tossing and turning, you are definitely not alone. The supplement aisle is packed with options promising to help you drift off, but they generally fall into a few different categories based on how they actually affect your body. Here...", "markdown_text": "If you are tossing and turning, you are definitely not alone. The supplement aisle is packed with options promising to help you drift off, but they generally fall into a few different categories based on how they actually affect your body.\n\n Here...", "citations": [ { "title": "Hartford HealthCare", "url": "https://hartfordhealthcare.org/about-us/news-press/news-detail?articleId=66180", "text": "Can These 3 Supplements Really Improve Your Sleep? | Hartford HealthCare | CT", "description": "- Valerian root. This herbal sleep option likely works by acting on GABA receptors in the brain, just like magnesium. \"But it's not without side effects,\" says ..." }, { "title": "BBC Good Food", "url": "https://www.bbcgoodfood.com/review/best-sleep-supplements#:~:text=It's%20easy%20to%20get%20enough,a%20role%20in%20sleep%20regulation.", "text": "The best sleep supplements 2026 – tried and tested - BBC Good Food", "description": "It's easy to get enough through diet, but if you are looking to supplement, the NRV is around 300mg, and look for magnesium glycinate which has been shown to ..." }, { "title": "PMC - NIH", "url": "https://pmc.ncbi.nlm.nih.gov/articles/PMC11082867/#:~:text=Melatonin%20is%20a%20hormone%20produced,promotes%20relaxation%20and%20reduced%20alertness.", "text": "Current Evidence on Common Dietary Supplements for Sleep Quality - PMC - NIH", "description": "Melatonin is a hormone produced by the pineal gland in the brain and plays a critical role in regulation of the sleep-wake cycle. The pineal gland begins ..." }, ... ], "parse_status_code": 12000 } } ] } ```
{% hint style="warning" %} The composition of response may vary depending on whether the query was made from a **desktop** or **mobile** device. {% endhint %} ### Output data dictionary All LLM targets return the same top-level `job` and `results[]` envelope. See [LLMs and AI](/api-targets/llms-and-ai.md) for the full metadata reference. The following table shows Gemini-specific `results[].content` fields:
Field NameDescriptionType
promptSubmitted prompt.string
rawRaw data from the streaming response.array
response_textPlain text response from Gemini.string
markdown_textComplete response in Markdown.string
citationsSource citations referenced in the response. Each object contains title, url, text, and description.array
parse_status_code12000 – successful. Otherwise, parser failed to extract some or all structured fields.integer
– conditional, returned only when content is in the LLM's response. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developers.oxylabs.io/api-targets/llms-and-ai/gemini.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.