> 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/products/web-scraper-api/targets/llms-and-ai/gemini.md).

# Gemini

Extract Gemini responses by submitting prompts and receive parsed data as structured JSON, plain text or Markdown.

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 to Gemini using [**Push-Pull**](/products/web-scraper-api/integration-methods/push-pull.md).

{% tabs %}
{% tab title="cURL" %}

<pre class="language-bash"><code class="lang-bash">curl 'https://data.oxylabs.io/v1/queries' \
--user 'USERNAME:PASSWORD' \
-H 'Content-Type: application/json' \
<strong>-d '{
</strong>        "source": "gemini",
        "prompt": "official websites of the most visited US national parks",
        "parse": true,
        "geo_location": "United States",
        "callback_url": "https://your-server.com/oxylabs-callback"
    }'
</code></pre>

{% endtab %}

{% tab title="Python" %}

```python
import requests
from pprint import pprint

# Structure payload.
payload = {
    'source': 'gemini',
    'prompt': 'official websites of the most visited US national parks',
    'parse': True,
    'geo_location': "United States",
    'callback_url': "https://your-server.com/oxylabs-callback"
}

# Get response.
response = requests.request(
    'POST',
    'https://data.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: "official websites of the most visited US national parks",
    parse: true,
    geo_location: "United States",
    callback_url: "https://your-server.com/oxylabs-callback"
};

const options = {
    hostname: "data.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="PHP" %}

```php
<?php

$params = array(
    'source' => 'gemini',
    'prompt' => 'official websites of the most visited US national parks',
    'parse' => true,
    'geo_location' => "United States",
    'callback_url' => "https://your-server.com/oxylabs-callback"
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://data.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":       "official websites of the most visited US national parks",
"parse":        true,
"geo_location": "United States",
"callback_url": "https://your-server.com/oxylabs-callback",
}

jsonValue, _ := json.Marshal(payload)

client := &http.Client{}
request, _ := http.NewRequest("POST",
"https://data.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 = "official websites of the most visited US national parks",
                parse = true,
                geo_location = "United States",
                callback_url = "https://your-server.com/oxylabs-callback"
            };

            var client = new HttpClient();

            Uri baseUri = new Uri("https://data.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;

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", "official websites of the most visited US national parks");
        jsonObject.put("parse", true);
        jsonObject.put("geo_location", "United States");
        jsonObject.put("callback_url", "https://your-server.com/oxylabs-callback");

        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)
                .build();

        var mediaType = MediaType.parse("application/json; charset=utf-8");
        var body = RequestBody.create(jsonObject.toString(), mediaType);
        var request = new Request.Builder()
                .url("https://data.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": "official websites of the most visited US national parks",
    "parse": true,
    "geo_location": "United States",
    "callback_url": "https://your-server.com/oxylabs-callback"
}
```

{% endtab %}
{% endtabs %}

Submitting a job with [**Push-Pull**](/products/web-scraper-api/integration-methods/push-pull.md) integration (including [batch queries](/products/web-scraper-api/integration-methods/push-pull.md#batch-query)) method returns the job ID immediately – not the result. Once the job status is `done`, retrieve the parsed response. See [**Integration method**](/products/web-scraper-api/integration-methods.md) on the LLMs and AI page for the full submit-and-retrieve flow.

### Request parameters

Basic setup and customization options for scraping Gemini.

<table><thead><tr><th width="222">Parameter</th><th width="350.3333333333333">Description</th><th>Default Value</th></tr></thead><tbody><tr><td><mark style="background-color:green;"><strong><code>source</code></strong></mark></td><td>Sets the scraper target. Use <code>gemini</code>.</td><td>–</td></tr><tr><td><mark style="background-color:green;"><strong><code>prompt</code></strong></mark></td><td>The prompt or question to submit to Gemini. Up to 8,000 characters.</td><td>–</td></tr><tr><td><code>callback_url</code></td><td><strong>Recommended.</strong> URL where we deliver a notification once the job completes. <a href="https://developers.oxylabs.io/products/web-scraper-api/integration-methods/push-pull"><strong>More info</strong></a><strong>.</strong></td><td>–</td></tr><tr><td><code>parse</code></td><td>Set to <code>true</code> for structured JSON data.</td><td><code>false</code></td></tr><tr><td><code>geo_location</code></td><td>Specify a country to route the request from. <a href="/products/web-scraper-api/features/localization.md"><strong>More info</strong></a>.</td><td>–</td></tr></tbody></table>

&#x20;   \- mandatory parameter

## Structured data

Once the job is retrieved via the Push-Pull results endpoint, Web Scraper API is capable of extracting a JSON object that contains Gemini output, offering structured data on various elements of the results page.

<details>

<summary><code>gemini</code> structured output</summary>

```json
{
  "results": [
    {
      "job_id": "7524040226335899649",
      "status_code": 200,
      "url": "https://gemini.google.com/app/3e15e0cac7f94e74",
      "content": {
        "prompt": "official websites of the most visited US national parks",
        "response_text": "Here are the official National Park Service (NPS) websites for the top 10 most visited U.S. national parks , based on annual visitor statistics: Great Smoky Mountains National Park (North Carolina & Tennessee) Official Website: nps.gov/grsm Zion Nati...",
        "markdown_text": "Here are the official National Park Service (NPS) websites for the **top 10 most visited U.S. national parks**, based on annual visitor statistics:\n\n1. **Great Smoky Mountains National Park** (North Carolina & Tennessee)\n\n   * **Official Website:**...",
        "citations": [
          {
            "description": "Table_title: Top 10 most visited national parks in 2025 Table_content: | \nRank | National park | 2025 visits | State / source / trend | | --- | --- | \n--- | --- |...",
            "text": "Here are the official National Park Service (NPS) websites for the **top 10 most visited U.S. national parks**, based on annual visitor statistics:",
            "title": "Most Visited U.S. National Parks in 2025: All 63 Ranked - StatRanker",
            "url": "https://statranker.org/nature/most-visited-u-s-national-parks-in-2025-rankings-and-visitor-trends/#:~:text=Table_title%3A%20Top%2010%20most%20visited%20national%20parks,YoY%20%2B0.8%25%20(calculated_value)%3B%202024%20rank%20%232%20(unchanged)."
          },
          {
            "description": "Table_title: Complete ranking: All 63 U.S. national parks in 2025 \nTable_content: | Rank | National park | 2025 visits | State / source / \ntrend | | --- | --- | -...",
            "text": "(North Carolina & Tennessee)",
            "title": "Most Visited U.S. National Parks in 2025: All 63 Ranked - StatRanker",
            "url": "https://statranker.org/nature/most-visited-u-s-national-parks-in-2025-rankings-and-visitor-trends/#:~:text=Table_title%3A%20Complete%20ranking%3A%20All%2063%20U.S.%20national,(2025).%202024%20NPS%3A%204%2C946%2C592%3B%20YoY%20%2B0.8%25%20(calculated_value)%3B"
          },
          {
            "description": "Table_title: Complete ranking: All 63 U.S. national parks in 2025 \nTable_content: | Rank | National park | 2025 visits | State / source / \ntrend | | --- | --- | -...",
            "text": "(Utah)",
            "title": "Most Visited U.S. National Parks in 2025: All 63 Ranked - StatRanker",
            "url": "https://statranker.org/nature/most-visited-u-s-national-parks-in-2025-rankings-and-visitor-trends/#:~:text=Table_title%3A%20Complete%20ranking%3A%20All%2063%20U.S.%20national,(2025).%202024%20NPS%3A%204%2C946%2C592%3B%20YoY%20%2B0.8%25%20(calculated_value)%3B"
          },
          ...
        ],
        "related_queries": [
          "Which of the most visited US national parks require advance reservations, timed entry passes, or lottery permits for hiking?"
        ],
        "links": [
          {
            "text": "nps.gov/grsm",
            "url": "https://www.nps.gov/grsm"
          },
          {
            "text": "nps.gov/zion",
            "url": "https://www.nps.gov/zion"
          },
          {
            "text": "nps.gov/yell",
            "url": "https://www.nps.gov/yell"
          },
          ...
        ],
        "additional_results": {
          "sources_results": [
            {
              "title": "Visitation Statistics - Social Science (U.S. National Park Service)",
              "url": "https://www.nps.gov/subjects/socialscience/highlights.htm"
            },
            {
              "title": "Explore America's national parks. Discover our most treasured",
              "url": "https://www.nationalparks.org/explore/parks"
            },
            ...
          ],
          "videos_results": [
            {
              "thumbnail": "https://i.ytimg.com/vi/bme0rs75Z3E/maxresdefault.jpg",
              "title": "Yellowstone National Park Vacation Travel Guide | Expedia",
              "url": "http://www.youtube.com/watch?v=bme0rs75Z3E"
            },
            {
              "thumbnail": "https://i.ytimg.com/vi/QYiddvAhffI/maxresdefault.jpg",
              "title": "GRAND CANYON NATIONAL PARK: Ultimate Travel Guide",
              "url": "http://www.youtube.com/watch?v=QYiddvAhffI"
            },
            ...
          ]
        },
        "model": "3.5 Flash-Lite",
        "parse_status_code": 12000
      }
    }
  ]
}
```

</details>

{% hint style="warning" %}
The composition of the 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-reference/dedicated-scrapers/llm-and-ai-scrapers.md) for the full metadata reference.

The following table shows Gemini-specific `results[].content` fields:

<table><thead><tr><th width="181.17578125">Field Name</th><th width="427">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>prompt</code></td><td>Submitted prompt.</td><td>string</td></tr><tr><td><code>raw_response</code></td><td>Raw streamed response from Gemini, one line per item.</td><td>array of strings</td></tr><tr><td><code>response_text</code></td><td>Plain text response from Gemini.</td><td>string</td></tr><tr><td><code>markdown_text</code></td><td>Complete response in Markdown.</td><td>string</td></tr><tr><td><mark style="background-color:$warning;"><code>citations</code></mark></td><td>Source citations referenced in the response. Each object contains <code>title</code>, <code>url</code>, <code>text</code>, and <code>description</code>.</td><td>array</td></tr><tr><td><mark style="background-color:$warning;"><code>additional_results</code></mark></td><td><p>Additional data attached to the answer. Each list is returned only when present in the answer: </p><ul><li><code>sources_results</code> - web pages Gemini consulted while answering (<code>url</code>, and optional <code>title</code>). </li><li><code>images_results</code> - images shown in the answer (<code>title</code>, <code>image_url</code>, and optional <code>image_from_url</code> - the page the image comes from). </li><li><code>videos_results</code> - YouTube videos shown in the answer (<code>url</code>, <code>title</code>, and optional <code>thumbnail</code>).</li></ul></td><td>object</td></tr><tr><td><mark style="background-color:$warning;"><code>related_queries</code></mark></td><td>Follow-up questions Gemini suggests under the answer.</td><td>array of strings</td></tr><tr><td><mark style="background-color:$warning;"><code>links</code></mark></td><td>List of objects for links written inside the answer text: <code>url</code> and <code>text</code>. <code>text</code> can be empty if the link has no visible text.</td><td>array</td></tr><tr><td><code>parse_status_code</code></td><td><code>12000</code> – successful. Otherwise, parser failed to extract some or all structured fields.</td><td>integer</td></tr><tr><td><mark style="background-color:$warning;"><code>model</code></mark></td><td>AI model used to generate the response.</td><td>string</td></tr></tbody></table>

&#x20;    – 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.oxylabs.io/products/web-scraper-api/targets/llms-and-ai/gemini.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
