Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare KV Key-Value Pairs API

4 actions 4 updates phrasing extends openapi/cloudflare-key-value-pairs-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 4

$.info
$.paths['/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}'].get
$.paths['/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}'].put
$.paths['/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}'].delete

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 KV Key-Value Pairs API
  version: 1.0.0
extends: openapi/cloudflare-key-value-pairs-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: 3
- target: $.paths['/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the value of a single KV key
      effect: read
      questions:
      - How do I read the value stored under one key in Workers KV?
      - Do special characters in a key name need URL-encoding when reading it?
      instructions:
      - text: Read the value of key {key} in namespace {namespace} on account {account}.
        slots:
          key: path.key_name
          namespace: path.namespace_id
          account: path.account_id
      - text: Get what's stored under {key} in KV namespace {namespace}, account {account}.
        slots:
          key: path.key_name
          namespace: path.namespace_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Write a value to a single KV key
      effect: write
      questions:
      - How do I store a value under one key in Workers KV?
      - Can I make a KV key expire automatically after a number of seconds?
      - Is it possible to set an absolute expiry time on a single key?
      instructions:
      - text: Write a value to key {key} in namespace {namespace} on account {account}.
        slots:
          key: path.key_name
          namespace: path.namespace_id
          account: path.account_id
      - text: Store key {key} in namespace {namespace}, account {account}, expiring after {expiration_ttl} seconds.
        slots:
          key: path.key_name
          namespace: path.namespace_id
          account: path.account_id
          expiration_ttl: query.expiration_ttl
      - text: Set key {key} in namespace {namespace} on account {account} to expire at timestamp {expiration}.
        slots:
          key: path.key_name
          namespace: path.namespace_id
          account: path.account_id
          expiration: query.expiration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single KV key
      effect: destructive
      questions:
      - How do I remove one key and its value from a KV namespace?
      - Can I delete a single KV entry by its key name?
      instructions:
      - text: Delete key {key} from KV namespace {namespace} in account {account}.
        slots:
          key: path.key_name
          namespace: path.namespace_id
          account: path.account_id
      - text: Remove the single entry {key} in namespace {namespace} on account {account}.
        slots:
          key: path.key_name
          namespace: path.namespace_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'