Generated by API Evangelist
Written by API Evangelist tooling for Thanx's API. It is a proposal applied on top of the contract, not a document Thanx publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Thanx Consumer Rewards API
version: 1.0.0
extends: openapi/thanx-rewards-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: 4
- target: $.paths['/rewards'].get
update:
x-apievangelist-phrasing:
intent: List loyalty rewards
effect: read
questions:
- Which loyalty rewards does a customer currently have?
- Can I list only rewards in a certain state, like available or used?
- How do I page through a merchant's rewards?
instructions:
- text: List rewards for user {user_id}.
slots:
user_id: query.user_id
- text: Show rewards in state {states} for merchant {merchant_id}.
slots:
states: query.states[]
merchant_id: query.merchant_id
- text: Get page {page} of rewards, {per_page} per page.
slots:
page: query.page
per_page: query.per_page
method: generated
generated: '2026-09-26'
- target: $.paths['/rewards/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one reward's details
effect: read
questions:
- What are the details and state of a specific reward?
- How do I look up a single reward by its ID in Thanx?
instructions:
- text: Get reward {id}.
slots:
id: path.id
- text: Show the current state of reward {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/rewards/{id}/activate'].post
update:
x-apievangelist-phrasing:
intent: Activate a reward for redemption
effect: write
questions:
- How do I make a reward ready to redeem?
- Does a reward need to be activated before it can be used?
instructions:
- text: Activate reward {id}.
slots:
id: path.id
- text: Make reward {id} redeemable now.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/rewards/{id}/finalize'].post
update:
x-apievangelist-phrasing:
intent: Finalize a reward after redemption
effect: destructive
questions:
- How do I mark a reward as finished once it has been redeemed?
- What step completes a reward after the customer uses it?
instructions:
- text: Finalize reward {id}.
slots:
id: path.id
- text: Close out redeemed reward {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
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.