Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation AI Gateway API

4 actions 4 updates phrasing extends openapi/netlify-ai-gateway-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Netlify's API. It is a proposal applied on top of the contract, not a document Netlify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/ai-gateway/providers'].get
$.paths['/sites/{site_id}/ai-gateway/token'].get
$.paths['/accounts/{account_id}/ai-gateway/token'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Netlify's API documentation AI Gateway API
  version: 1.0.0
extends: openapi/netlify-ai-gateway-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/ai-gateway/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI Gateway providers
      effect: read
      questions:
      - Which model providers can I reach through the AI Gateway?
      - What AI providers and models does the gateway support?
      instructions:
      - text: List the providers available in the AI Gateway.
      - text: Show which AI model providers the gateway supports.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sites/{site_id}/ai-gateway/token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI Gateway token for a site
      effect: read
      questions:
      - Can I get an AI Gateway token scoped to one site?
      - Where do I get credentials for my site to call the AI Gateway?
      instructions:
      - text: Get an AI Gateway token for site {site}.
        slots:
          site: path.site_id
      - text: Fetch site {site}'s AI Gateway token.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{account_id}/ai-gateway/token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI Gateway token for a team
      effect: read
      questions:
      - Can I get an AI Gateway token for my whole team instead of one site?
      - Is there an account-level AI Gateway token?
      instructions:
      - text: Get an AI Gateway token for account {account}.
        slots:
          account: path.account_id
      - text: Fetch the team-wide AI Gateway token for account {account}.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-10-01'