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 Interaction API
version: 1.0.0
extends: openapi/hint-health-interaction-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/interactions'].get
update:
x-apievangelist-phrasing:
intent: List patient interactions
effect: read
questions:
- What interactions have been logged for a patient?
- Can I filter interactions by type or status?
instructions:
- text: List interactions for patient {patient_id}.
slots:
patient_id: query.patient_id
- text: List interactions of type {type} with status {status}.
slots:
type: query.type
status: query.status
- text: Show interactions updated since {updated_at}.
slots:
updated_at: query.updated_at
method: generated
generated: '2026-10-01'
- target: $.paths['/provider/interactions/{interaction_id}/files/download_urls'].get
update:
x-apievangelist-phrasing:
intent: Get download links for all interaction files
effect: read
questions:
- Can I download every file attached to an interaction at once?
- Why do some interaction files come back with no download URL?
instructions:
- text: Get download URLs for all files on interaction {interaction_id}.
slots:
interaction_id: path.interaction_id
- text: List the attached file links for interaction {interaction_id}.
slots:
interaction_id: path.interaction_id
method: generated
generated: '2026-10-01'
- target: $.paths['/provider/interactions/{interaction_id}/files/{id}/download_url'].get
update:
x-apievangelist-phrasing:
intent: Get a download link for one interaction file
effect: read
questions:
- Can I get a download link for just one file on an interaction?
- Why would a single file download return a 422?
instructions:
- text: Get a download URL for file {id} on interaction {interaction_id}.
slots:
id: path.id
interaction_id: path.interaction_id
- text: Fetch a one-time link to download file {id} from interaction {interaction_id}.
slots:
id: path.id
interaction_id: path.interaction_id
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.