Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Web3 Wallets API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/me/web3_wallets'].get
$.paths['/v1/me/web3_wallets'].post
$.paths['/v1/me/web3_wallets/{web3_wallet_id}'].get
$.paths['/v1/me/web3_wallets/{web3_wallet_id}'].delete
$.paths['/v1/me/web3_wallets/{web3_wallet_id}/prepare_verification'].post
$.paths['/v1/me/web3_wallets/{web3_wallet_id}/attempt_verification'].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 Clerk Frontend Web3 Wallets API
  version: 1.0.0
extends: openapi/clerk-com-web3-wallets-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['/v1/me/web3_wallets'].get
  update:
    x-apievangelist-phrasing:
      intent: List my web3 wallets
      effect: read
      questions:
      - Which crypto wallets are linked to my account?
      - How do I see every web3 wallet address on my own profile?
      instructions:
      - text: List my web3 wallets.
      - text: Show every wallet address linked to my profile.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/web3_wallets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a web3 wallet to my account
      effect: write
      questions:
      - How do I link an Ethereum wallet address to my account?
      - Can I add a second web3 wallet to my profile?
      instructions:
      - text: Add web3 wallet {web3_wallet} to my account.
        slots:
          web3_wallet: requestBody.web3_wallet
      - text: Link wallet address {web3_wallet} to my profile.
        slots:
          web3_wallet: requestBody.web3_wallet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/web3_wallets/{web3_wallet_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my web3 wallets
      effect: read
      questions:
      - Is a wallet I linked verified yet?
      - How do I look up one linked wallet by its ID?
      instructions:
      - text: Show my web3 wallet {web3_wallet_id}.
        slots:
          web3_wallet_id: path.web3_wallet_id
      - text: Check whether my wallet {web3_wallet_id} is verified.
        slots:
          web3_wallet_id: path.web3_wallet_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/web3_wallets/{web3_wallet_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a web3 wallet from my account
      effect: destructive
      questions:
      - How do I unlink a crypto wallet from my profile?
      - Can I delete a web3 wallet I linked by mistake?
      instructions:
      - text: Remove web3 wallet {web3_wallet_id} from my account.
        slots:
          web3_wallet_id: path.web3_wallet_id
      - text: Unlink wallet {web3_wallet_id} from my profile.
        slots:
          web3_wallet_id: path.web3_wallet_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/web3_wallets/{web3_wallet_id}/prepare_verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Start verifying a web3 wallet
      effect: write
      questions:
      - How do I get a message to sign so I can prove I own a wallet?
      - Which strategies can I use to verify a web3 wallet?
      instructions:
      - text: Prepare verification of wallet {web3_wallet_id} with strategy {strategy}.
        slots:
          web3_wallet_id: path.web3_wallet_id
          strategy: requestBody.strategy
      - text: Get a message to sign for wallet {web3_wallet_id} via {strategy}, redirecting to {redirect_url}.
        slots:
          web3_wallet_id: path.web3_wallet_id
          strategy: requestBody.strategy
          redirect_url: requestBody.redirect_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/web3_wallets/{web3_wallet_id}/attempt_verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a web3 wallet with a signature
      effect: write
      questions:
      - How do I submit my wallet signature to finish verification?
      - What completes web3 wallet verification after I sign the message?
      instructions:
      - text: Verify wallet {web3_wallet_id} with signature {signature}.
        slots:
          web3_wallet_id: path.web3_wallet_id
          signature: requestBody.signature
      - text: Submit signature {signature} to prove I own wallet {web3_wallet_id}.
        slots:
          signature: requestBody.signature
          web3_wallet_id: path.web3_wallet_id
      method: generated
      generated: '2026-09-26'