ScrapeBadger.Api.GeminiApi

All URIs are relative to https://scrapebadger.com

Method	HTTP request	Description
GeminiAskGeminiAQuestion	GET /v1/gemini/ask	Ask Gemini a question
GeminiAskGeminiAQuestionPost	POST /v1/gemini/ask	Ask Gemini a question (POST)
GeminiGeminiScraperHealthCheck	GET /v1/gemini/health	Gemini scraper health check
GeminiGeminiScraperHealthCheckHead	HEAD /v1/gemini/health	Gemini scraper health check
GeminiMeasureABrandSVisibilityInAGeminiAnswer	GET /v1/gemini/brand-visibility	Measure a brand's visibility in a Gemini answer
GeminiMeasureABrandSVisibilityInAGeminiAnswerPost	POST /v1/gemini/brand-visibility	Measure a brand's visibility in a Gemini answer (POST)

GeminiAskGeminiAQuestion

Object GeminiAskGeminiAQuestion (string prompt, string country = null, string webSearch = null, string imageUrl = null)

Ask Gemini a question

Send a prompt to Gemini and get the answer plus the web sources it cited.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class GeminiAskGeminiAQuestionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new GeminiApi(httpClient, config, httpClientHandler);
            var prompt = "prompt_example";  // string | The prompt to send to Gemini (max 4096 characters).
            var country = "country_example";  // string | ISO-3166 alpha-2 egress country, e.g. 'US', 'GB', 'DE'. (optional) 
            var webSearch = "\"auto\"";  // string | auto (let Gemini decide) | force (ask it to browse) | off (answer from memory). `web_search_triggered` in the response always reports what actually happened. (optional)  (default to "auto")
            var imageUrl = "imageUrl_example";  // string | UNAVAILABLE. Signed-out Gemini refuses image questions — it accepts the upload and then answers PERMISSION_DENIED to its own generate RPC, so this returns 422 immediately rather than charging for a render that cannot succeed. Use /v1/chatgpt/ask for image input. (optional) 

            try
            {
                // Ask Gemini a question
                Object result = apiInstance.GeminiAskGeminiAQuestion(prompt, country, webSearch, imageUrl);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GeminiApi.GeminiAskGeminiAQuestion: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GeminiAskGeminiAQuestionWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Ask Gemini a question
    ApiResponse<Object> response = apiInstance.GeminiAskGeminiAQuestionWithHttpInfo(prompt, country, webSearch, imageUrl);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling GeminiApi.GeminiAskGeminiAQuestionWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
prompt	string	The prompt to send to Gemini (max 4096 characters).
country	string	ISO-3166 alpha-2 egress country, e.g. 'US', 'GB', 'DE'.	[optional]
webSearch	string	auto (let Gemini decide)	force (ask it to browse)
imageUrl	string	UNAVAILABLE. Signed-out Gemini refuses image questions — it accepts the upload and then answers PERMISSION_DENIED to its own generate RPC, so this returns 422 immediately rather than charging for a render that cannot succeed. Use /v1/chatgpt/ask for image input.	[optional]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GeminiAskGeminiAQuestionPost

Object GeminiAskGeminiAQuestionPost ()

Ask Gemini a question (POST)

POST form of /ask, for prompts too long for a query string.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class GeminiAskGeminiAQuestionPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new GeminiApi(httpClient, config, httpClientHandler);

            try
            {
                // Ask Gemini a question (POST)
                Object result = apiInstance.GeminiAskGeminiAQuestionPost();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GeminiApi.GeminiAskGeminiAQuestionPost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GeminiAskGeminiAQuestionPostWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Ask Gemini a question (POST)
    ApiResponse<Object> response = apiInstance.GeminiAskGeminiAQuestionPostWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling GeminiApi.GeminiAskGeminiAQuestionPostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GeminiGeminiScraperHealthCheck

Object GeminiGeminiScraperHealthCheck ()

Gemini scraper health check

Check health of the Gemini scraper service (accepts HEAD).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class GeminiGeminiScraperHealthCheckExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new GeminiApi(httpClient, config, httpClientHandler);

            try
            {
                // Gemini scraper health check
                Object result = apiInstance.GeminiGeminiScraperHealthCheck();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GeminiApi.GeminiGeminiScraperHealthCheck: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GeminiGeminiScraperHealthCheckWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Gemini scraper health check
    ApiResponse<Object> response = apiInstance.GeminiGeminiScraperHealthCheckWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling GeminiApi.GeminiGeminiScraperHealthCheckWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GeminiGeminiScraperHealthCheckHead

Object GeminiGeminiScraperHealthCheckHead ()

Gemini scraper health check

Check health of the Gemini scraper service (accepts HEAD).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class GeminiGeminiScraperHealthCheckHeadExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new GeminiApi(httpClient, config, httpClientHandler);

            try
            {
                // Gemini scraper health check
                Object result = apiInstance.GeminiGeminiScraperHealthCheckHead();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GeminiApi.GeminiGeminiScraperHealthCheckHead: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GeminiGeminiScraperHealthCheckHeadWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Gemini scraper health check
    ApiResponse<Object> response = apiInstance.GeminiGeminiScraperHealthCheckHeadWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling GeminiApi.GeminiGeminiScraperHealthCheckHeadWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GeminiMeasureABrandSVisibilityInAGeminiAnswer

Object GeminiMeasureABrandSVisibilityInAGeminiAnswer (string prompt, string brand, string domain = null, string aliases = null, string competitors = null, string country = null, string webSearch = null)

Measure a brand's visibility in a Gemini answer

Ask Gemini, then report whether the brand is mentioned, cited and how prominently.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class GeminiMeasureABrandSVisibilityInAGeminiAnswerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new GeminiApi(httpClient, config, httpClientHandler);
            var prompt = "prompt_example";  // string | The prompt to ask Gemini.
            var brand = "brand_example";  // string | Brand name to look for in the answer.
            var domain = "domain_example";  // string | Brand domain, for citation matching. (optional) 
            var aliases = "aliases_example";  // string | Comma-separated alternative names. (optional) 
            var competitors = "competitors_example";  // string | Comma-separated competitor names. (optional) 
            var country = "country_example";  // string | ISO-3166 alpha-2 egress country. (optional) 
            var webSearch = "\"force\"";  // string | auto | force | off (optional)  (default to "force")

            try
            {
                // Measure a brand's visibility in a Gemini answer
                Object result = apiInstance.GeminiMeasureABrandSVisibilityInAGeminiAnswer(prompt, brand, domain, aliases, competitors, country, webSearch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GeminiApi.GeminiMeasureABrandSVisibilityInAGeminiAnswer: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GeminiMeasureABrandSVisibilityInAGeminiAnswerWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Measure a brand's visibility in a Gemini answer
    ApiResponse<Object> response = apiInstance.GeminiMeasureABrandSVisibilityInAGeminiAnswerWithHttpInfo(prompt, brand, domain, aliases, competitors, country, webSearch);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling GeminiApi.GeminiMeasureABrandSVisibilityInAGeminiAnswerWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
prompt	string	The prompt to ask Gemini.
brand	string	Brand name to look for in the answer.
domain	string	Brand domain, for citation matching.	[optional]
aliases	string	Comma-separated alternative names.	[optional]
competitors	string	Comma-separated competitor names.	[optional]
country	string	ISO-3166 alpha-2 egress country.	[optional]
webSearch	string	auto	force

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GeminiMeasureABrandSVisibilityInAGeminiAnswerPost

Object GeminiMeasureABrandSVisibilityInAGeminiAnswerPost ()

Measure a brand's visibility in a Gemini answer (POST)

POST form, for longer prompts and larger competitor sets.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class GeminiMeasureABrandSVisibilityInAGeminiAnswerPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new GeminiApi(httpClient, config, httpClientHandler);

            try
            {
                // Measure a brand's visibility in a Gemini answer (POST)
                Object result = apiInstance.GeminiMeasureABrandSVisibilityInAGeminiAnswerPost();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GeminiApi.GeminiMeasureABrandSVisibilityInAGeminiAnswerPost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GeminiMeasureABrandSVisibilityInAGeminiAnswerPostWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Measure a brand's visibility in a Gemini answer (POST)
    ApiResponse<Object> response = apiInstance.GeminiMeasureABrandSVisibilityInAGeminiAnswerPostWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling GeminiApi.GeminiMeasureABrandSVisibilityInAGeminiAnswerPostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

GeminiApi.md

Latest commit

History

GeminiApi.md

File metadata and controls

ScrapeBadger.Api.GeminiApi

GeminiAskGeminiAQuestion

Example

Using the GeminiAskGeminiAQuestionWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GeminiAskGeminiAQuestionPost

Example

Using the GeminiAskGeminiAQuestionPostWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GeminiGeminiScraperHealthCheck

Example

Using the GeminiGeminiScraperHealthCheckWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GeminiGeminiScraperHealthCheckHead

Example

Using the GeminiGeminiScraperHealthCheckHeadWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GeminiMeasureABrandSVisibilityInAGeminiAnswer

Example

Using the GeminiMeasureABrandSVisibilityInAGeminiAnswerWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GeminiMeasureABrandSVisibilityInAGeminiAnswerPost

Example

Using the GeminiMeasureABrandSVisibilityInAGeminiAnswerPostWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details