Serper · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Serper Locations API

5 actions 5 updates update extends ../openapi/serper-locations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Serper's API. It is a proposal applied on top of the contract, not a document Serper publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-credit-costx-mini-batchx-billingcontacttermsOfServicex-apievangelist-profilex-conventionsx-rate-limits

Targets 5

$.info

$.components.securitySchemes

$.paths['/locations'].get

$.paths['/health'].get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Serper Locations API
  version: 1.0.0
extends: ../openapi/serper-locations-api-openapi.yml
x-provenance:
  generated: '2026-08-13'
  method: generated
  source: openapi/serper-locations-api-openapi.yml + conventions/, rate-limits/, errors/, lifecycle/ in
    this repo
actions:
- target: $.info
  description: Record API Evangelist provenance and the real support contact.
  update:
    contact:
      name: Serper Support
      url: https://serper.dev
      email: support@serper.dev
    termsOfService: https://serper.dev/terms
    x-apievangelist-profile: https://github.com/api-evangelist/serper
- target: $
  description: Attach the runtime semantics Serper does not publish in the spec itself.
  update:
    x-conventions: conventions/serper-conventions.yml
    x-rate-limits: rate-limits/serper-rate-limits.yml
    x-plans: plans/serper-plans-pricing.yml
    x-errors: errors/serper-problem-types.yml
    x-lifecycle: lifecycle/serper-lifecycle.yml
    x-authentication: authentication/serper-authentication.yml
    x-status-page: https://serper.betteruptime.com
- target: $.components.securitySchemes
  description: 'Record the second, weaker auth convention Serper also accepts: the API key as an apiKey
    query parameter on a GET.'
  update:
    apiKeyQuery:
      type: apiKey
      in: query
      name: apiKey
      description: Alternative to X-API-KEY, emitted by Serper's own playground when GET is selected.
        Places the credential in the URL; prefer the header.
- target: $.paths['/locations'].get
  description: Annotate listLocations with its credit cost and mini-batch behaviour.
  update:
    x-credit-cost: see rate-limits/serper-rate-limits.yml#creditCosts
    x-mini-batch: Send an array of up to 100 query objects to this path; costs 3x.
    x-billing: Credits are deducted only on a successful response.
- target: $.paths['/health'].get
  description: Annotate getHealth with its credit cost and mini-batch behaviour.
  update:
    x-credit-cost: see rate-limits/serper-rate-limits.yml#creditCosts
    x-mini-batch: Send an array of up to 100 query objects to this path; costs 3x.
    x-billing: Credits are deducted only on a successful response.