Generated by API Evangelist
Written by API Evangelist tooling for Hint Health's API. It is a proposal applied on top of the contract, not a document Hint Health publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Hint Health Credit API
version: 1.0.0
extends: openapi/hint-health-credit-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/provider/patients/{patient_id}/credits'].get
update:
x-apievangelist-phrasing:
intent: List a patient's credits
effect: read
questions:
- What account credits does a patient have?
- Can I see all credits applied to one patient?
instructions:
- text: List credits for patient {patient_id}.
slots:
patient_id: path.patient_id
- text: Show every credit on patient {patient_id}'s account.
slots:
patient_id: path.patient_id
method: generated
generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/credits'].post
update:
x-apievangelist-phrasing:
intent: Give a patient an account credit
effect: write
questions:
- How do I add a credit to a patient's account?
- Can I record a reason when issuing a patient credit?
instructions:
- text: Give patient {patient_id} a credit of {amount_in_cents} cents in category {credit_category}.
slots:
patient_id: path.patient_id
amount_in_cents: requestBody.amount_in_cents
credit_category: requestBody.credit_category
- text: Credit {amount_in_cents} cents to patient {patient_id} under {credit_category} for {reason}.
slots:
amount_in_cents: requestBody.amount_in_cents
patient_id: path.patient_id
credit_category: requestBody.credit_category
reason: requestBody.reason
method: generated
generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/credits/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Change an existing patient credit
effect: write
questions:
- Can I adjust the amount of a credit I already gave a patient?
- Is it possible to edit the reason on an existing credit?
instructions:
- text: Change credit {id} on patient {patient_id} to {amount_in_cents} cents.
slots:
id: path.id
patient_id: path.patient_id
amount_in_cents: requestBody.amount_in_cents
- text: Adjust existing credit {id} for patient {patient_id} to {amount_in_cents} cents with reason {reason}.
slots:
id: path.id
patient_id: path.patient_id
amount_in_cents: requestBody.amount_in_cents
reason: requestBody.reason
method: generated
generated: '2026-10-01'
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.