Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik Guest Wallets API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/v1/guest-wallets'].post
$.paths['/api/v1/guest-wallets/topups'].post
$.paths['/api/v1/guest-wallets/status'].get

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 Xquik Guest Wallets API
  version: 1.0.0
extends: openapi/xquik-api-guest-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: 3
- target: $.paths['/api/v1/guest-wallets'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a prepaid guest wallet checkout
      effect: write
      questions:
      - Can I buy API reads without creating an Xquik account?
      - What amounts can a prepaid guest wallet be funded with?
      - Does creating a guest wallet charge me right away?
      instructions:
      - text: Create a guest wallet checkout for {amount_minor} in {currency}.
        slots:
          amount_minor: requestBody.amount_minor
          currency: requestBody.currency
      - text: Start a new prepaid guest wallet checkout of {amount_minor} {currency}.
        slots:
          amount_minor: requestBody.amount_minor
          currency: requestBody.currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/guest-wallets/topups'].post
  update:
    x-apievangelist-phrasing:
      intent: Top up an existing guest wallet
      effect: write
      questions:
      - How do I add more funds to my existing guest key?
      - Does topping up a guest wallet give me a new API key?
      instructions:
      - text: Top up my guest wallet with {amount_minor} {currency}.
        slots:
          amount_minor: requestBody.amount_minor
          currency: requestBody.currency
      - text: Create another checkout to refill my guest key by {amount_minor} in {currency}.
        slots:
          amount_minor: requestBody.amount_minor
          currency: requestBody.currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/guest-wallets/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check guest wallet payment status
      effect: read
      questions:
      - Has my guest wallet payment gone through yet?
      - Can my guest key still make paid reads while a top-up is pending?
      instructions:
      - text: Check my guest wallet status.
      - text: Poll whether my guest wallet is usable for paid reads.
      method: generated
      generated: '2026-09-26'