serpkite 0.1.1 → 0.3.0

package/dist/index.d.cts

@@ -88,7 +88,7 @@ interface paths {
         /** Same as POST /v1/search with query-string parameters */
         get: operations["searchGet"];
         put?: never;
-        /** Google web search (organic results, AI Overview, knowledge graph, answer box, people also ask, top stories, local pack…) */
+        /** Google web search (organic results, knowledge graph, answer box, people also ask, top stories, local pack…) */
         post: operations["search"];
         delete?: never;
         options?: never;
@@ -156,7 +156,7 @@ interface paths {
         };
         get?: never;
         put?: never;
-        /** Google Maps search (places with coordinates). Accepts `ll` ("@lat,lng,zoomz") */
+        /** Google Maps search (places with coordinates). Accepts `ll` ("@lat,lng,zoomz") to search around a point */
         post: operations["maps"];
         delete?: never;
         options?: never;
@@ -266,40 +266,6 @@ interface paths {
         patch?: never;
         trace?: never;
     };
-    "/v1/lens": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /** Google Lens visual matches for an image URL (2 credits) */
-        post: operations["lens"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/v1/ai-mode": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /** Google AI Mode answer with citations (3 credits) */
-        post: operations["aiMode"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/v1/webpage": {
         parameters: {
             query?: never;
@@ -465,7 +431,7 @@ interface paths {
         };
         get?: never;
         put?: never;
-        /** Remote MCP server (streamable HTTP, JSON-RPC 2.0). Tools search, news, maps, scholar, webpage, ai_overview */
+        /** Remote MCP server (streamable HTTP, JSON-RPC 2.0). Tools search, news, maps, scholar, webpage */
         post: operations["mcp"];
         delete?: never;
         options?: never;
@@ -504,20 +470,20 @@ interface components {
         SearchRequest: {
             q: string;
             /**
-             * @description Country code (ISO 3166-1 alpha-2)
+             * @description Country code (ISO 3166-1 alpha-2, case-insensitive; uk is accepted as gb). When omitted and location ends in a country name, that country is used
              * @default us
              */
             country?: string;
             /**
-             * @description Interface language (e.g. en
+             * @description Interface language: a language code with an optional region (e.g. en, de, pt-br, zh-tw, es-419)
              * @default en
              */
             language?: string;
             /** @description Free-text location, e.g. "Austin, Texas, United States" */
             location?: string;
-            /** @description Pre-encoded Google location (overrides location) */
+            /** @description Pre-encoded Google location (overrides ll and location; percent-encoded values are decoded) */
             uule?: string;
-            /** @description Maps viewport "@lat,lng,14z" (maps only) */
+            /** @description Map point "@lat,lng,14z" (maps and places only; zoom optional): the search runs as a searcher at that point. Overrides location */
             ll?: string;
             /**
              * @description 10, or up to 100 for the depth bundle on search and news (7 credits for 100; values between round up to whole pages). Other verticals return one page of 10
@@ -527,11 +493,11 @@ interface components {
             /** @default 1 */
             page?: number;
             /**
-             * @description Only results from the last hour/day/…
+             * @description Only results from the last hour/day/… (search, news, images, videos, shopping). A fallback engine without that window is skipped, never answered unfiltered
              * @enum {string}
              */
             time?: "hour" | "day" | "week" | "month" | "year";
-            /** @description Advanced: raw Google tbs filter (e.g. qdr:d); overrides time */
+            /** @description Advanced: raw Google tbs filter (e.g. qdr:d, qdr:w2, cdr:1,cd_min:1/1/2026,cd_max:1/31/2026); overrides time */
             tbs?: string;
             /**
              * @default desktop
@@ -550,15 +516,13 @@ interface components {
              * @enum {string}
              */
             format?: "json" | "markdown" | "compact";
-            /** @description Comma-separated projection, e.g. "results.title,results.link,ai_overview" */
+            /** @description Comma-separated projection, e.g. "results.title,results.link,knowledge_graph" */
             fields?: string;
             /**
              * @description Also fetch the top N organic pages as Markdown (+1 credit each fetched page)
              * @default 0
              */
             include_content?: number;
-            /** @default true */
-            ai_overview?: boolean;
             /**
              * @description Include sponsored results
              * @default false
@@ -592,19 +556,6 @@ interface components {
             fields?: string;
             max_age?: number;
         };
-        LensRequest: {
-            /**
-             * Format: uri
-             * @description Image URL
-             */
-            url: string;
-            country?: string;
-            language?: string;
-            /** @enum {string} */
-            format?: "json" | "markdown" | "compact";
-            fields?: string;
-            max_age?: number;
-        };
         WebpageRequest: {
             /** Format: uri */
             url: string;
@@ -662,7 +613,7 @@ interface components {
             /**
              * @example search
              * @example news
-             * @example ai-mode
+             * @example webpage
              */
             endpoint: string;
             /** @description The engine policy as asked (google, auto, one provider or a list) */
@@ -720,17 +671,6 @@ interface components {
              */
             sources?: components["schemas"]["Provider"][];
         };
-        Reference: {
-            title?: string;
-            link: string;
-            domain?: string;
-            snippet?: string;
-        };
-        AIOverview: {
-            text?: string;
-            markdown?: string;
-            references?: components["schemas"]["Reference"][];
-        };
         AnswerBox: {
             title?: string;
             answer?: string;
@@ -762,7 +702,6 @@ interface components {
         SearchResponse: {
             request: components["schemas"]["RequestEcho"];
             results: components["schemas"]["OrganicResult"][];
-            ai_overview: components["schemas"]["AIOverview"] | null;
             answer_box?: components["schemas"]["AnswerBox"];
             knowledge_graph?: components["schemas"]["KnowledgeGraph"];
             ads?: components["schemas"]["OrganicResult"][];
@@ -935,28 +874,6 @@ interface components {
             results: components["schemas"]["Suggestion"][];
             meta: components["schemas"]["Meta"];
         };
-        LensResult: {
-            position: number;
-            title: string;
-            source?: string;
-            link: string;
-            domain?: string;
-            image_url?: string;
-            thumbnail_url?: string;
-        };
-        LensResponse: {
-            request: components["schemas"]["RequestEcho"];
-            results: components["schemas"]["LensResult"][];
-            meta: components["schemas"]["Meta"];
-        };
-        AIModeResponse: {
-            request: components["schemas"]["RequestEcho"];
-            answer: string;
-            markdown?: string;
-            /** @description Cited sources */
-            results: components["schemas"]["Reference"][];
-            meta: components["schemas"]["Meta"];
-        };
         PageMetadata: {
             title?: string;
             description?: string;
@@ -1059,7 +976,7 @@ interface components {
         };
         BatchCreateRequest: {
             /** @enum {string} */
-            endpoint: "search" | "images" | "videos" | "news" | "maps" | "places" | "reviews" | "shopping" | "scholar" | "patents" | "autocomplete" | "lens" | "ai-mode" | "webpage";
+            endpoint: "search" | "images" | "videos" | "news" | "maps" | "places" | "reviews" | "shopping" | "scholar" | "patents" | "autocomplete" | "webpage";
             /** @description Request bodies for `endpoint` (same fields as the realtime endpoint) */
             requests: {
                 [key: string]: unknown;
@@ -1304,38 +1221,6 @@ interface components {
             };
         };
         /** @description OK (text/markdown when format=markdown) */
-        LensOK: {
-            headers: {
-                "X-Credits-Used": components["headers"]["CreditsUsed"];
-                "X-Credits-Remaining": components["headers"]["CreditsRemaining"];
-                "X-Cost-USD": components["headers"]["CostUSD"];
-                "X-Cache": components["headers"]["Cache"];
-                "X-Latency-Ms": components["headers"]["LatencyMs"];
-                "X-Tokens-Estimate": components["headers"]["TokensEstimate"];
-                [name: string]: unknown;
-            };
-            content: {
-                "application/json": components["schemas"]["LensResponse"];
-                "text/markdown": string;
-            };
-        };
-        /** @description OK (text/markdown when format=markdown) */
-        AIModeOK: {
-            headers: {
-                "X-Credits-Used": components["headers"]["CreditsUsed"];
-                "X-Credits-Remaining": components["headers"]["CreditsRemaining"];
-                "X-Cost-USD": components["headers"]["CostUSD"];
-                "X-Cache": components["headers"]["Cache"];
-                "X-Latency-Ms": components["headers"]["LatencyMs"];
-                "X-Tokens-Estimate": components["headers"]["TokensEstimate"];
-                [name: string]: unknown;
-            };
-            content: {
-                "application/json": components["schemas"]["AIModeResponse"];
-                "text/markdown": string;
-            };
-        };
-        /** @description OK (text/markdown when format=markdown) */
         WebpageOK: {
             headers: {
                 "X-Credits-Used": components["headers"]["CreditsUsed"];
@@ -1392,7 +1277,6 @@ interface operations {
                 format?: string;
                 fields?: string;
                 include_content?: number;
-                ai_overview?: boolean;
                 ads?: boolean;
                 max_age?: number;
                 /** @description google (default), auto, consensus, one provider, or a comma-separated list (e.g. google,brave) */
@@ -1616,46 +1500,6 @@ interface operations {
             503: components["responses"]["Unavailable"];
         };
     };
-    lens: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["LensRequest"];
-            };
-        };
-        responses: {
-            200: components["responses"]["LensOK"];
-            400: components["responses"]["Error"];
-            401: components["responses"]["Error"];
-            402: components["responses"]["Error"];
-            403: components["responses"]["Error"];
-            429: components["responses"]["Error"];
-            503: components["responses"]["Unavailable"];
-        };
-    };
-    aiMode: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: components["requestBodies"]["Search"];
-        responses: {
-            200: components["responses"]["AIModeOK"];
-            400: components["responses"]["Error"];
-            401: components["responses"]["Error"];
-            402: components["responses"]["Error"];
-            403: components["responses"]["Error"];
-            429: components["responses"]["Error"];
-            503: components["responses"]["Unavailable"];
-        };
-    };
     webpage: {
         parameters: {
             query?: never;
@@ -1955,13 +1799,12 @@ type Engine = "google" | "auto" | "consensus" | Provider | Provider[] | (string
 /** One provider attempt in `meta.route`. */
 type RouteStep = Schemas["RouteStep"];
 type RouteOutcome = RouteStep["outcome"];
-/** Parameters for search, images, videos, news, maps, places, shopping, scholar, patents, autocomplete and aiMode. */
+/** Parameters for search, images, videos, news, maps, places, shopping, scholar, patents and autocomplete. */
 type SearchParams = Omit<Schemas["SearchRequest"], "engine"> & {
     /** Search providers allowed to answer. Default `"google"`. See {@link Engine}. */
     engine?: Engine;
 };
 type ReviewsParams = Schemas["ReviewsRequest"];
-type LensParams = Schemas["LensRequest"];
 type WebpageParams = Schemas["WebpageRequest"];
 type RankParams = Schemas["RankRequest"];
 /** `format` values accepted by the verticals. */
@@ -1971,8 +1814,6 @@ type RequestEcho = Schemas["RequestEcho"];
 type ErrorBody = Schemas["Error"];
 type OrganicResult = Schemas["OrganicResult"];
 type Sitelink = Schemas["Sitelink"];
-type Reference = Schemas["Reference"];
-type AIOverview = Schemas["AIOverview"];
 type AnswerBox = Schemas["AnswerBox"];
 type KnowledgeGraph = Schemas["KnowledgeGraph"];
 type PeopleAlsoAsk = Schemas["PeopleAlsoAsk"];
@@ -1986,7 +1827,6 @@ type ShoppingResult = Schemas["ShoppingResult"];
 type ScholarResult = Schemas["ScholarResult"];
 type PatentResult = Schemas["PatentResult"];
 type Suggestion = Schemas["Suggestion"];
-type LensResult = Schemas["LensResult"];
 type PageMetadata = Schemas["PageMetadata"];
 type RankMatch = Schemas["RankResponse"]["matches"][number];
 type SearchResponse = Schemas["SearchResponse"];
@@ -2001,8 +1841,6 @@ type ShoppingResponse = Schemas["ShoppingResponse"];
 type ScholarResponse = Schemas["ScholarResponse"];
 type PatentsResponse = Schemas["PatentsResponse"];
 type AutocompleteResponse = Schemas["AutocompleteResponse"];
-type LensResponse = Schemas["LensResponse"];
-type AIModeResponse = Schemas["AIModeResponse"];
 type WebpageResponse = Schemas["WebpageResponse"];
 type RankResponse = Schemas["RankResponse"];
 type Account = Schemas["Account"];
@@ -2041,8 +1879,6 @@ type BatchRequestMap = {
     scholar: SearchParams;
     patents: SearchParams;
     autocomplete: SearchParams;
-    lens: LensParams;
-    "ai-mode": SearchParams;
     webpage: WebpageParams;
 };
 /** Body of `POST /v1/batches`. `requests` takes the same fields as the realtime endpoint. */
@@ -2056,7 +1892,7 @@ type BatchCreateParams = {
     };
 }[BatchEndpoint];
 
-declare const VERSION = "0.1.1";
+declare const VERSION = "0.3.0";
 declare const DEFAULT_BASE_URL = "https://api.serpkite.com";
 interface SerpKiteOptions {
     /** API key (`skt_live_…`). Defaults to the `SERPKITE_API_KEY` environment variable. */
@@ -2143,11 +1979,10 @@ declare class SerpKite {
     readonly maxRetries: number;
     readonly retryDelayMs: number;
     constructor(options?: SerpKiteOptions);
-    /** Google web search: organic results, AI Overview, answer box, knowledge graph, people also ask… */
+    /** Google web search: organic results, answer box, knowledge graph, people also ask… */
     readonly search: VerticalMethod<SearchParams, {
         request: components["schemas"]["RequestEcho"];
         results: components["schemas"]["OrganicResult"][];
-        ai_overview: components["schemas"]["AIOverview"] | null;
         answer_box?: components["schemas"]["AnswerBox"];
         knowledge_graph?: components["schemas"]["KnowledgeGraph"];
         ads?: components["schemas"]["OrganicResult"][];
@@ -2230,14 +2065,6 @@ declare class SerpKite {
         results: components["schemas"]["Suggestion"][];
         meta: components["schemas"]["Meta"];
     }>;
-    /** Google AI Mode answer with cited sources. */
-    readonly aiMode: VerticalMethod<SearchParams, {
-        request: components["schemas"]["RequestEcho"];
-        answer: string;
-        markdown?: string;
-        results: components["schemas"]["Reference"][];
-        meta: components["schemas"]["Meta"];
-    }>;
     /** Fetch any public URL as clean Markdown plus metadata. */
     readonly webpage: VerticalMethod<{
         url: string;
@@ -2254,8 +2081,6 @@ declare class SerpKite {
         metadata: components["schemas"]["PageMetadata"];
         meta: components["schemas"]["Meta"];
     }>;
-    /** Google Lens visual matches for an image URL. */
-    lens(params: LensParams, options?: RequestOptions): Promise<LensResponse>;
     /** Position of `domain` for keyword `q` in the top `num` results (default 100). */
     rank(params: RankParams, options?: RequestOptions): Promise<RankResponse>;
     /** Balance, limits and this month's usage for the key's account. */
@@ -2343,4 +2168,4 @@ type HeaderSource = Headers | Record<string, string | string[] | undefined>;
  */
 declare function verifyWebhook(secret: string, payload: string | Uint8Array, headers: HeaderSource, options?: VerifyWebhookOptions): Promise<boolean>;
 
-export { type AIModeResponse, type AIOverview, type Account, type AnswerBox, type AutocompleteResponse, type Batch, type BatchCreateEntry, type BatchCreateError, type BatchCreateOptions, type BatchCreateParams, type BatchCreateResponse, type BatchEndpoint, type BatchStatus, type CompactResponse, DEFAULT_BASE_URL, type Engine, type ErrorBody, type Format, type ImageResult, type ImagesResponse, type KnowledgeGraph, type LensParams, type LensResponse, type LensResult, type MapsResponse, type Meta, type NewsResponse, type NewsResult, type OrganicResult, type PageMetadata, type PatentResult, type PatentsResponse, type PeopleAlsoAsk, type PlaceResult, type PlacesResponse, type Provider, type RankMatch, type RankParams, type RankResponse, type Reference, type RelatedSearch, type RequestEcho, type RequestOptions, type ResponseInfo, type ReviewResult, type ReviewsParams, type ReviewsResponse, type RouteOutcome, type RouteStep, type ScholarResponse, type ScholarResult, type SearchParams, type SearchResponse, SerpKite, SerpKiteError, type SerpKiteOptions, type ShoppingResponse, type ShoppingResult, type Sitelink, type Status, type Suggestion, VERSION, type VerifyWebhookOptions, type VerticalMethod, type VideoResult, type VideosResponse, type WaitOptions, type WebpageParams, type WebpageResponse, type components, isBatchError, type operations, parseRetryAfter, type paths, verifyWebhook };
+export { type Account, type AnswerBox, type AutocompleteResponse, type Batch, type BatchCreateEntry, type BatchCreateError, type BatchCreateOptions, type BatchCreateParams, type BatchCreateResponse, type BatchEndpoint, type BatchStatus, type CompactResponse, DEFAULT_BASE_URL, type Engine, type ErrorBody, type Format, type ImageResult, type ImagesResponse, type KnowledgeGraph, type MapsResponse, type Meta, type NewsResponse, type NewsResult, type OrganicResult, type PageMetadata, type PatentResult, type PatentsResponse, type PeopleAlsoAsk, type PlaceResult, type PlacesResponse, type Provider, type RankMatch, type RankParams, type RankResponse, type RelatedSearch, type RequestEcho, type RequestOptions, type ResponseInfo, type ReviewResult, type ReviewsParams, type ReviewsResponse, type RouteOutcome, type RouteStep, type ScholarResponse, type ScholarResult, type SearchParams, type SearchResponse, SerpKite, SerpKiteError, type SerpKiteOptions, type ShoppingResponse, type ShoppingResult, type Sitelink, type Status, type Suggestion, VERSION, type VerifyWebhookOptions, type VerticalMethod, type VideoResult, type VideosResponse, type WaitOptions, type WebpageParams, type WebpageResponse, type components, isBatchError, type operations, parseRetryAfter, type paths, verifyWebhook };