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 Partner API
version: 1.0.0
extends: openapi/hint-health-partner-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: 4
- target: $.paths['/partner'].get
update:
x-apievangelist-phrasing:
intent: View my partner profile (legacy)
effect: read
questions:
- Where do I see my partner profile with marketing and support URLs under the older route?
- What webhook URL and logo are on my legacy partner record?
instructions:
- text: Show my legacy partner profile.
- text: Get my partner marketing URL, support URL and logo from the older partner endpoint.
method: generated
generated: '2026-10-01'
- target: $.paths['/partner'].patch
update:
x-apievangelist-phrasing:
intent: Update partner listing details (legacy)
effect: write
questions:
- How do I change my partner marketing URL, support URL or product description?
- Can I update the logo and integration description on my partner listing?
instructions:
- text: Set my partner support URL to {support_url}.
slots:
support_url: requestBody.support_url
- text: Update my partner marketing URL to {marketing_url} and logo to {logo_url}.
slots:
marketing_url: requestBody.marketing_url
logo_url: requestBody.logo_url
- text: Change my partner integration description to {integration_description}.
slots:
integration_description: requestBody.integration_description
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/partner'].get
update:
x-apievangelist-phrasing:
intent: View my partner account
effect: read
questions:
- What name and contact email are on my partner account?
- Which partner account am I authenticated as?
instructions:
- text: Show my partner account.
- text: Get my partner name and email.
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/partner'].patch
update:
x-apievangelist-phrasing:
intent: Rename my partner account or change its email
effect: write
questions:
- How do I rename my partner account?
- Can I change the contact email on my partner account?
instructions:
- text: Rename my partner account to {name}.
slots:
name: requestBody.name
- text: Change my partner account email to {email}.
slots:
email: requestBody.email
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.