Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Turnstile Verification API

2 actions 2 updates phrasing extends openapi/cloudflare-verification-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 2

$.info

$.paths['/siteverify'].post

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 Turnstile Verification API
  version: 1.0.0
extends: openapi/cloudflare-verification-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: 1
- target: $.paths['/siteverify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a Turnstile token server-side
      effect: read
      questions:
      - How do I check on my server that a visitor actually passed the Turnstile challenge?
      - Can I include the user's IP address when validating a Turnstile token?
      instructions:
      - text: Verify Turnstile token {response} using secret {secret}.
        slots:
          response: requestBody.response
          secret: requestBody.secret
      - text: Validate token {response} for visitor IP {remoteip} with secret key {secret}.
        slots:
          response: requestBody.response
          remoteip: requestBody.remoteip
          secret: requestBody.secret
      method: generated
      generated: '2026-09-26'