Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Accounts Keys API

6 actions 6 updates phrasing extends openapi/twilio-keys-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/Accounts/{AccountSid}/Keys.json'].get

$.paths['/Accounts/{AccountSid}/Keys.json'].post

$.paths['/Accounts/{AccountSid}/Keys/{KeySid}.json'].get

$.paths['/Accounts/{AccountSid}/Keys/{KeySid}.json'].post

$.paths['/Accounts/{AccountSid}/Keys/{KeySid}.json'].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 Twilio Accounts Keys API
  version: 1.0.0
extends: openapi/twilio-keys-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/{AccountSid}/Keys.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List API keys
      effect: read
      questions:
      - Which API keys exist on my account?
      - Can I audit every API credential that has been issued for an account?
      instructions:
      - text: List the API keys on account {account_sid}.
        slots:
          account_sid: path.AccountSid
      - text: Show every API credential issued for account {account_sid}.
        slots:
          account_sid: path.AccountSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Accounts/{AccountSid}/Keys.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key
      effect: write
      questions:
      - How do I generate a new API key instead of using my auth token?
      - Will I be able to see the key secret again after I create it?
      instructions:
      - text: Create a new API key on account {account_sid}.
        slots:
          account_sid: path.AccountSid
      - text: Generate an API key named {friendly_name} for account {account_sid}.
        slots:
          friendly_name: requestBody.FriendlyName
          account_sid: path.AccountSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Accounts/{AccountSid}/Keys/{KeySid}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one API key
      effect: read
      questions:
      - When was a particular API key created and what is it called?
      - Can I look up the details of one API key by its SID?
      instructions:
      - text: Get API key {key_sid} on account {account_sid}.
        slots:
          key_sid: path.KeySid
          account_sid: path.AccountSid
      - text: Show the details of key {key_sid} in account {account_sid}.
        slots:
          key_sid: path.KeySid
          account_sid: path.AccountSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Accounts/{AccountSid}/Keys/{KeySid}.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename an API key
      effect: write
      questions:
      - Can I relabel an API key so I remember which service uses it?
      - Is the friendly name the only thing I can change on an existing key?
      instructions:
      - text: Rename API key {key_sid} on account {account_sid} to {friendly_name}.
        slots:
          key_sid: path.KeySid
          account_sid: path.AccountSid
          friendly_name: requestBody.FriendlyName
      - text: Change the label of existing key {key_sid} in account {account_sid} to {friendly_name}.
        slots:
          key_sid: path.KeySid
          account_sid: path.AccountSid
          friendly_name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Accounts/{AccountSid}/Keys/{KeySid}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an API key
      effect: destructive
      questions:
      - How do I revoke an API key that may have leaked?
      - What happens to apps using a key once I delete it?
      instructions:
      - text: Delete API key {key_sid} from account {account_sid}.
        slots:
          key_sid: path.KeySid
          account_sid: path.AccountSid
      - text: Revoke compromised key {key_sid} on account {account_sid} now.
        slots:
          key_sid: path.KeySid
          account_sid: path.AccountSid
      method: generated
      generated: '2026-09-26'