Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Images API

6 actions 6 updates phrasing extends openapi/cloudflare-images-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}/images/v1'].get
$.paths['/accounts/{account_id}/images/v1'].post
$.paths['/accounts/{account_id}/images/v1/{image_id}'].get
$.paths['/accounts/{account_id}/images/v1/{image_id}'].delete
$.paths['/accounts/{account_id}/images/v1/{image_id}'].patch

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 Cloudflare Images API
  version: 1.0.0
extends: openapi/cloudflare-images-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}/images/v1'].get
  update:
    x-apievangelist-phrasing:
      intent: List the images stored in an account
      effect: read
      questions:
      - Which images have I stored in Cloudflare Images?
      - Can I page through my images a set number at a time?
      instructions:
      - text: List the images in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show page {page} of my images, {per_page} per page.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/images/v1'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an image from a file or URL
      effect: write
      questions:
      - How do I upload an image by pointing at a URL instead of a file?
      - Which image formats can I upload?
      - Can I require signed URLs for an image when I upload it?
      instructions:
      - text: Upload the image at {url} to account {account_id}.
        slots:
          url: requestBody.url
          account_id: path.account_id
      - text: Upload this image file with custom ID {id}.
        slots:
          id: requestBody.id
      - text: Upload {file} and require signed URLs to view it.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/images/v1/{image_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one image
      effect: read
      questions:
      - What details are stored for a specific uploaded image?
      - Can I look up one image by its ID?
      instructions:
      - text: Get image {image_id} in account {account_id}.
        slots:
          image_id: path.image_id
          account_id: path.account_id
      - text: Show the details of image {image_id}.
        slots:
          image_id: path.image_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/images/v1/{image_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an image and all its variants
      effect: destructive
      questions:
      - Does deleting an image also remove its variants?
      - How do I permanently delete an image I uploaded?
      instructions:
      - text: Delete image {image_id} from account {account_id}.
        slots:
          image_id: path.image_id
          account_id: path.account_id
      - text: Remove image {image_id} and every variant of it.
        slots:
          image_id: path.image_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/images/v1/{image_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an image's metadata or signing
      effect: write
      questions:
      - Can I change the metadata on an image I already uploaded?
      - Is it possible to turn signed-URL protection on for an existing image?
      instructions:
      - text: Update the metadata of existing image {image_id} in account {account_id}.
        slots:
          image_id: path.image_id
          account_id: path.account_id
      - text: Set requireSignedURLs to {requireSignedURLs} on existing image {image_id}.
        slots:
          requireSignedURLs: requestBody.requireSignedURLs
          image_id: path.image_id
      method: generated
      generated: '2026-09-26'