SerpKite Webpage API

openapi: 3.2.0
info:
  title: SerpKite SERP Webpage API
  version: 1.12.4
  description: 'Public search API (api.serpkite.com). Google results as clean JSON or Markdown

    for AI agents, plus a Google Custom Search–compatible endpoint. Official SDKs:

    `serpkite` on npm and PyPI, `github.com/serpkite/serpkite-go`. **Auth:** `Authorization: Bearer skt_live_…`. A bare `Authorization: skt_live_…`

    (no scheme) is also accepted, for MCP hosts that can''t add one. GET requests

    may pass `?api_key=` instead. `/customsearch/v1` also accepts Google''s `?key=`. **Bodies:** every vertical accepts `POST` with a JSON object or `GET` with the

    same parameters in the query string (only `GET /v1/search` is spelled out

    here). Unknown parameters are rejected with 400, and so is a parameter the

    endpoint would ignore (e.g. `time` on `/v1/scholar`, `ll` on `/v1/search`). To run many queries at once,

    use `POST /v1/batches`. **Formats:** `format=json` (default) returns the schemas below. `format=markdown` returns `text/markdown` for every vertical. `format=compact` and `fields=` return a reduced JSON object (same top-level

    keys, fewer item fields, `meta` always kept), so required item fields may be

    absent there. **Responses** share one envelope: `request` (the normalised request),

    `results` (the vertical''s primary list), vertical-specific extras and `meta`. All keys are snake_case. **Credits** are decimal numbers (e.g. `0.5`). Failed, empty and blocked

    responses are refunded. Every billed response carries `X-Credits-Used`,

    `X-Credits-Remaining`, `X-Cost-USD`, `X-Cache` (`HIT`|`MISS`), `X-Latency-Ms`,

    `X-Tokens-Estimate` and `X-Request-Id`. **Errors** share one body: `{"error":{"code","message","request_id"}}`. Upstream failures (`upstream_error`, `upstream_blocked`, `upstream_timeout`)

    are `503` with `Retry-After`, never billed and safe to retry. The API never

    returns `502` or `504`. `429` also carries `Retry-After`: `rate_limited` is

    the per-second limit; `daily_limit_reached` is the free daily limit of an

    account that never bought a pack, which resets at 00:00 UTC (the message

    names the limit and the billing page; buying any pack removes it). `403 account_restricted` means the account''s free use is paused because it

    appears to be one of several accounts run by the same person (same device

    or network, or requests in step with other accounts) or uses a disposable

    email address; buying any pack lifts it. **CORS:** `Access-Control-Allow-Origin: *` without credentials; the `X-*`

    headers above are exposed, so a browser playground can call the API with a key. The keyless `/playground/search` is the exception: it only answers serpkite.com

    and app.serpkite.com (other `Origin`s get 403). Credit table: search/news/images/videos/maps/places/shopping/scholar/patents/

    webpage/customsearch = 1 per page; place details = 1; `num=100` depth bundle = 7; reviews = 1 per 10;

    autocomplete = 0.5; `include_content` = +1 per fetched page;

    batches ×0.5 (from 2026-11-23 a batch depth request is 0.5 per page with

    results, without the bundle cap: `num=100` = 5); cache hit via `max_age` ×0.5. `engine=consensus` (search only) =

    the sum of one page per provider that returned results. **AI** (Claude writes, OpenAI''s Decisions API runs typed checks; a failed

    model step is never billed): an answer (`include_answer` on `/v1/search` and

    `/v1/news`, the model part of `/v1/answer`) = +2 over the result page, +4

    when it read pages (`include_content`, `/v1/answer` depth=standard);

    `/v1/extract` `summary` = +4 and `output_schema` = +4 per page;

    `/v1/research` = lite 30, standard 75, deep 200. Responses that used a

    model carry `meta.llm`. **AI assistants** (`/v1/chatgpt`, `/v1/gemini`, `/v1/copilot`,

    `/v1/ai_mode`, `/v1/brave_ai`): a `prompt` sent to the public assistant

    as a logged-out user; the response is its answer

    (`text`, `markdown`) with the `sources` it cited or listed,

    `search_queries`, `products` and `places` where the assistant shows them,

    and `mentions` for the brands and domains in `track`.'
servers:
- url: https://api.serpkite.com
- url: http://localhost:8080
security:
- bearer: []
tags:
- name: Webpage
paths:
  /v1/webpage:
    post:
      summary: Fetch any public URL (HTML or PDF) and return clean Markdown + metadata (1…
      operationId: webpage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebpageRequest'
      responses:
        '200':
          $ref: '#/components/responses/WebpageOK'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Unavailable'
      tags:
      - Webpage
components:
  headers:
    RetryAfter:
      description: Seconds to wait before retrying
      schema:
        type: integer
    CreditsRemaining:
      schema:
        type: number
    TokensEstimate:
      schema:
        type: integer
    LatencyMs:
      schema:
        type: integer
    CreditsUsed:
      schema:
        type: number
    CostUSD:
      schema:
        type: number
    Cache:
      schema:
        type: string
        enum:
        - HIT
        - MISS
  responses:
    Unavailable:
      description: 'Temporarily unavailable, not billed, safe to retry after `Retry-After`.

        Codes: `upstream_error` (the upstream page couldn''t be fetched or parsed),

        `upstream_blocked` (the upstream is rate limiting us or refused the query), `upstream_timeout`

        (the search took too long), `unavailable` (endpoint or dependency down).

        The API never sends 502 or 504.

        '
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    WebpageOK:
      description: OK (text/markdown when format=markdown)
      headers:
        X-Credits-Used:
          $ref: '#/components/headers/CreditsUsed'
        X-Credits-Remaining:
          $ref: '#/components/headers/CreditsRemaining'
        X-Cost-USD:
          $ref: '#/components/headers/CostUSD'
        X-Cache:
          $ref: '#/components/headers/Cache'
        X-Latency-Ms:
          $ref: '#/components/headers/LatencyMs'
        X-Tokens-Estimate:
          $ref: '#/components/headers/TokensEstimate'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WebpageResponse'
        text/markdown:
          schema:
            type: string
  schemas:
    PageLink:
      type: object
      required:
      - url
      properties:
        url:
          type: string
          description: Absolute URL
        text:
          type: string
          description: Anchor text
    PageMetadata:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        language:
          type: string
        canonical:
          type: string
        site_name:
          type: string
        image:
          type: string
        published_time:
          type: string
        author:
          type: string
        content_type:
          type: string
          description: The page's media type
          examples:
          - text/html
          - application/pdf
        pages:
          type: integer
          description: Page count of a PDF
    WebpageRequest:
      type: object
      required:
      - url
      properties:
        url:
          type: string
          format: uri
          description: An HTML page or a PDF
        format:
          type: string
          enum:
          - json
          - markdown
          - compact
          default: json
        include_html:
          type: boolean
          default: false
        include_links:
          type: boolean
          default: false
          description: Also return the page's outbound links (`links`)
        include_images:
          type: boolean
          default: false
          description: Also return the page's image URLs (`image_links`)
        country:
          type: string
          description: Fetch the page as seen from this country (ISO 3166-1 alpha-2) for geo-dependent pages
        max_age:
          type: integer
    WebpageResponse:
      type: object
      required:
      - request
      - url
      - markdown
      - metadata
      - meta
      properties:
        request:
          $ref: '#/components/schemas/RequestEcho'
        url:
          type: string
          description: Final URL after redirects
        status_code:
          type: integer
        markdown:
          type: string
        text:
          type: string
        html:
          type: string
          description: Only with include_html=true
        metadata:
          $ref: '#/components/schemas/PageMetadata'
        links:
          type: array
          items:
            $ref: '#/components/schemas/PageLink'
          description: include_links=true only. Outbound links in document order, deduplicated
        image_links:
          type: array
          items:
            type: string
          description: include_images=true only. Image URLs in document order
        meta:
          $ref: '#/components/schemas/Meta'
    Meta:
      type: object
      required:
      - request_id
      - credits_used
      - cached
      properties:
        request_id:
          type: string
        credits_used:
          type: number
        engine:
          type: string
          description: The provider that produced the result (`consensus` for a merged engine=consensus answer)
          examples:
          - google
          - brave
          - consensus
          - stub
        route:
          type: array
          description: Provider attempts in order (fresh results only; absent on cache hits). With engine=consensus, every provider started; ones stopped early are `canceled`, ones cut off by the deadline `timeout`
          items:
            $ref: '#/components/schemas/RouteStep'
        cached:
          type: boolean
        cached_at:
          type: string
          format: date-time
        resolved_urls:
          type: boolean
        parse_quality:
          type: string
          enum:
          - ok
          - partial
          - empty
        latency_ms:
          type: integer
        llm:
          $ref: '#/components/schemas/LLMUsage'
        warnings:
          type: array
          items:
            type: string
          description: Non-fatal problems, e.g. an include_answer that failed (and was refunded)
    RouteStep:
      type: object
      description: One provider attempt behind this answer.
      required:
      - provider
      - outcome
      - ms
      properties:
        provider:
          type: string
          examples:
          - google
          - brave
        outcome:
          type: string
          enum:
          - ok
          - partial
          - empty
          - soft_empty
          - blocked
          - timeout
          - error
          - unsupported
          - bad_param
          - bad_target
          - canceled
        ms:
          type: integer
          description: Duration of the attempt in milliseconds
    LLMUsage:
      type: object
      description: The model that wrote this response's AI part and the tokens it used
      properties:
        provider:
          type: string
          examples:
          - anthropic
          - openai
        model:
          type: string
          examples:
          - claude-haiku-5-5
          - gpt-6-luna
        input_tokens:
          type: integer
        output_tokens:
          type: integer
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              description: '403: spend_cap_reached, key_limit_reached, account_restricted, forbidden. 409/422: idempotency_key_reused. 422: target_unavailable (the URL you asked for failed: its site answered 404, its domain doesn''t resolve; resending won''t help), no_pages. 429: rate_limited, daily_limit_reached. 503: upstream_error, upstream_blocked, upstream_timeout, unavailable (the API never sends 502 or 504)'
              examples:
              - unauthorized
              - invalid_request
              - insufficient_credits
              - rate_limited
              - daily_limit_reached
              - spend_cap_reached
              - key_limit_reached
              - account_restricted
              - idempotency_key_reused
              - forbidden
              - not_found
              - upstream_error
              - upstream_blocked
              - upstream_timeout
              - unavailable
              - internal
            message:
              type: string
            request_id:
              type: string
    RequestEcho:
      type: object
      description: The normalised request that produced this response (defaults filled in)
      required:
      - endpoint
      - engine
      additionalProperties: true
      properties:
        endpoint:
          type: string
          examples:
          - search
          - news
          - webpage
          - chatgpt
        engine:
          description: The engine policy as asked (google, auto, one provider or a list)
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        q:
          type: string
        url:
          type: string
        country:
          type: string
        language:
          type: string
        location:
          type: string
        num:
          type: integer
        page:
          type: integer
        device:
          type: string
        autocorrect:
          type: boolean
        tbs:
          type: string
        start_date:
          type: string
          format: date
        end_date:
          type: string
          format: date
        safe:
          type: string
        place_id:
          type: string
        cid:
          type: string
        fid:
          type: string
        oid:
          type: string
        sort:
          type: string
        include_content:
          type: integer
        format:
          type: string
        include_domains:
          type: array
          items:
            type: string
        exclude_domains:
          type: array
          items:
            type: string
        boost_domains:
          type: array
          items:
            type: string
        highlights:
          type: boolean
        include_answer:
          type: boolean
        prompt:
          type: string
          description: AI assistant endpoints
        web_search:
          type: boolean
          description: /v1/chatgpt
        include_html:
          type: boolean
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
    oauth:
      type: oauth2
      description: OAuth 2.1 for the remote MCP server only (authorization code + PKCE S256; app-api.serpkite.com is the authorization server).
      flows:
        authorizationCode:
          authorizationUrl: https://app-api.serpkite.com/oauth/authorize
          tokenUrl: https://app-api.serpkite.com/oauth/token
          refreshUrl: https://app-api.serpkite.com/oauth/token
          scopes:
            mcp: Use the SerpKite MCP tools, billed to your account
            offline_access: Stay connected with refresh tokens