Generated by API Evangelist
Written by API Evangelist tooling for Amazon API Gateway's API. It is a proposal applied on top of the contract, not a document Amazon API Gateway publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Amazon API Gateway REST API Keys API
version: 1.0.0
extends: openapi/aws-api-gateway-api-keys-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: 5
- target: $.paths['/apikeys'].get
update:
x-apievangelist-phrasing:
intent: List API keys
effect: read
questions:
- What API keys exist in my API Gateway account?
- Can I find API keys by name prefix or by the customer they belong to?
- Is there a way to see the actual key values when listing all keys?
instructions:
- text: List all my API Gateway API keys.
- text: List API keys whose name starts with {nameQuery}.
slots:
nameQuery: query.nameQuery
- text: Show the API keys issued to customer {customerId}, including their values.
slots:
customerId: query.customerId
method: generated
generated: '2026-10-01'
- target: $.paths['/apikeys'].post
update:
x-apievangelist-phrasing:
intent: Create an API key
effect: write
questions:
- How do I issue a new API key for a client of my API?
- Can I supply my own key value instead of having one generated?
- Can a new API key be tied to a marketplace customer ID when it is created?
instructions:
- text: Create an enabled API key named {name}.
slots:
name: requestBody.name
- text: Create an API key called {name} for customer {customerId}.
slots:
name: requestBody.name
customerId: requestBody.customerId
- text: Create an API key named {name} with the value {value}.
slots:
name: requestBody.name
value: requestBody.value
method: generated
generated: '2026-10-01'
- target: $.paths['/apikeys/{api_key}'].get
update:
x-apievangelist-phrasing:
intent: Look up one API key
effect: read
questions:
- How do I see the details of one specific API key?
- Can I reveal the secret value of a single API key?
instructions:
- text: Show me API key {api_key}.
slots:
api_key: path.api_key
- text: Get API key {api_key} and include its key value.
slots:
api_key: path.api_key
method: generated
generated: '2026-10-01'
- target: $.paths['/apikeys/{api_key}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an API key
effect: destructive
questions:
- How do I permanently remove an API key that is no longer needed?
- What happens to clients still using an API key once I delete it?
instructions:
- text: Delete API key {api_key}.
slots:
api_key: path.api_key
- text: Remove the leaked API key {api_key} from my account.
slots:
api_key: path.api_key
method: generated
generated: '2026-10-01'
- target: $.paths['/apikeys/{api_key}'].patch
update:
x-apievangelist-phrasing:
intent: Change an existing API key
effect: write
questions:
- Can I disable an existing API key without deleting it?
- How do I rename or re-describe an API key I already issued?
instructions:
- text: Disable API key {api_key}.
slots:
api_key: path.api_key
- text: 'Apply these patch operations to API key {api_key}: {patchOperations}.'
slots:
api_key: path.api_key
patchOperations: requestBody.patchOperations
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.