Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare AI Gateway Gateways API

6 actions 6 updates phrasing extends openapi/cloudflare-gateways-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/accounts/{account_id}/ai-gateway/gateways'].get

$.paths['/accounts/{account_id}/ai-gateway/gateways'].post

$.paths['/accounts/{account_id}/ai-gateway/gateways/{gateway_id}'].get

$.paths['/accounts/{account_id}/ai-gateway/gateways/{gateway_id}'].put

$.paths['/accounts/{account_id}/ai-gateway/gateways/{gateway_id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudflare AI Gateway Gateways API
  version: 1.0.0
extends: openapi/cloudflare-gateways-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/accounts/{account_id}/ai-gateway/gateways'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI Gateways
      effect: read
      questions:
      - Which AI Gateways have I set up in Cloudflare?
      - Can I get a list of all my AI Gateway instances?
      instructions:
      - text: List all AI Gateways in account {account}.
        slots:
          account: path.account_id
      - text: Show me every AI Gateway instance I have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/ai-gateway/gateways'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AI Gateway
      effect: write
      questions:
      - How do I set up a new AI Gateway in front of my model calls?
      - Can I turn on response caching with a TTL when creating a gateway?
      - Is it possible to rate-limit requests through a new AI Gateway from day one?
      instructions:
      - text: Create an AI Gateway named {name} with caching for {cache_ttl} seconds.
        slots:
          name: requestBody.name
          cache_ttl: requestBody.cache_ttl
      - text: In account {account}, create AI Gateway {name} limited to {rate_limiting_limit} requests per {rate_limiting_interval} seconds.
        slots:
          account: path.account_id
          name: requestBody.name
          rate_limiting_limit: requestBody.rate_limiting_limit
          rate_limiting_interval: requestBody.rate_limiting_interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/ai-gateway/gateways/{gateway_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI Gateway's configuration
      effect: read
      questions:
      - What caching and rate-limit settings does one of my AI Gateways use?
      - Can I check whether logging is enabled on a specific gateway?
      instructions:
      - text: Get the configuration of AI Gateway {gateway}.
        slots:
          gateway: path.gateway_id
      - text: Show AI Gateway {gateway} in account {account}.
        slots:
          gateway: path.gateway_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/ai-gateway/gateways/{gateway_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an AI Gateway's settings
      effect: write
      questions:
      - How do I change the cache TTL on an existing AI Gateway?
      - Can I switch off request logging on a gateway I already created?
      instructions:
      - text: Update AI Gateway {gateway} to cache responses for {cache_ttl} seconds.
        slots:
          gateway: path.gateway_id
          cache_ttl: requestBody.cache_ttl
      - text: Set the logging on existing gateway {gateway} named {name} in account {account} to {log_enabled}.
        slots:
          account: path.account_id
          gateway: path.gateway_id
          name: requestBody.name
          log_enabled: requestBody.log_enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/ai-gateway/gateways/{gateway_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AI Gateway
      effect: destructive
      questions:
      - How do I delete an AI Gateway I no longer need?
      - Can I permanently remove one AI Gateway instance from my account?
      instructions:
      - text: Delete AI Gateway {gateway}.
        slots:
          gateway: path.gateway_id
      - text: Remove AI Gateway {gateway} from account {account}.
        slots:
          gateway: path.gateway_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'