Kinde · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kinde Management API Keys API

7 actions 7 updates phrasing extends openapi/kinde-api-keys-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Kinde's API. It is a proposal applied on top of the contract, not a document Kinde publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/v1/api_keys'].get
$.paths['/api/v1/api_keys'].post
$.paths['/api/v1/api_keys/{key_id}'].get
$.paths['/api/v1/api_keys/{key_id}'].put
$.paths['/api/v1/api_keys/{key_id}'].delete
$.paths['/api/v1/api_keys/verify'].post

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 Kinde Management API Keys API
  version: 1.0.0
extends: openapi/kinde-api-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: 6
- target: $.paths['/api/v1/api_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List API keys
      effect: read
      questions:
      - Which API keys exist in my Kinde business right now?
      - Can I list only the active API keys that belong to a particular organization?
      - What API keys has a specific user been issued?
      instructions:
      - text: List all my API keys.
      - text: Show API keys with status {status} for organization {org_code}.
        slots:
          status: query.status
          org_code: query.org_code
      - text: List the API keys issued to user {user_id}.
        slots:
          user_id: query.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/api_keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key
      effect: write
      questions:
      - How do I issue a new API key that can call one of my registered APIs?
      - Can I create an API key scoped to a single organization or user?
      - What do I need to provide to generate a fresh API key?
      instructions:
      - text: Create a {type} API key named {name} for API {api_id}.
        slots:
          type: requestBody.type
          name: requestBody.name
          api_id: requestBody.api_id
      - text: Issue an API key called {name} of type {type} for API {api_id}, owned by organization {org_code}.
        slots:
          name: requestBody.name
          type: requestBody.type
          api_id: requestBody.api_id
          org_code: requestBody.org_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/api_keys/{key_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API key's details
      effect: read
      questions:
      - Where can I see the details of one specific API key?
      - Can I check which API and scopes a single key is tied to?
      instructions:
      - text: Show the details of API key {key_id}.
        slots:
          key_id: path.key_id
      - text: Look up API key {key_id} and tell me its status.
        slots:
          key_id: path.key_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/api_keys/{key_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rotate an API key
      effect: write
      questions:
      - How do I rotate an API key without losing its permissions?
      - Can I regenerate a key's secret while keeping the same associations?
      instructions:
      - text: Rotate API key {key_id}.
        slots:
          key_id: path.key_id
      - text: Generate a new secret for API key {key_id}, keeping its permissions.
        slots:
          key_id: path.key_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/api_keys/{key_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API key
      effect: destructive
      questions:
      - How do I permanently remove an API key I no longer use?
      - Can I delete a leaked API key outright rather than rotating it?
      instructions:
      - text: Delete API key {key_id}.
        slots:
          key_id: path.key_id
      - text: Remove the API key {key_id} from my account for good.
        slots:
          key_id: path.key_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/api_keys/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an API key
      effect: read
      questions:
      - Can I check whether an API key presented to my service is valid?
      - Is there a public endpoint to validate a key without authenticating first?
      instructions:
      - text: Verify the API key {api_key}.
        slots:
          api_key: requestBody.api_key
      - text: Check if {api_key} is a valid, working API key.
        slots:
          api_key: requestBody.api_key
      method: generated
      generated: '2026-09-26'