APIs Overview

This overview maps Site Search API families and shared conventions. For complete request and response contracts, use the endpoint-specific articles.

What This Article Covers

  • Shared authentication model summary
  • Shared error and limit guidance links
  • Cross-links to endpoint-specific docs

Endpoint-level procedures are in dedicated API articles.

Request Parameters (Overview-Level)

Name Required Type Description
Authorization Yes header Authentication model varies by linked endpoint family (token auth and Discovery key auth).
q Yes query string Primary query parameter used by linked Search API requests.
language No query string Optional language code used by linked suggest and discovery requests.

Shared HTTP Status and Error Guidance

This overview summarizes shared status and error guidance. Endpoint articles contain endpoint-specific details:

  • Common success status: 200 (endpoint-specific response shape)
  • Common auth failures: 401 or 403 depending on endpoint family and header format
  • Common limit failures: 429, 413, 414
  • Possible service failure: 500

Endpoint articles provide precise trigger conditions and payload-level error details.

Pagination

Not applicable in this overview article. Pagination contracts are endpoint-specific.

Rate Limits and Backoff

  • Shared app-level guidance: 20+ requests/second.
  • Shared plan-limit behavior can return 429.
  • Retry-After is not guaranteed. Implement retry delays in your client.

Shared API Foundations

Use these shared references for authentication, request and response structure, and pagination behavior used across Site Search APIs:

Articles in this section