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 Partner Endpoints App Surface API
version: 1.0.0
extends: openapi/hint-health-appsurface-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['/partner/products/{product_id}/app/surfaces'].post
update:
x-apievangelist-phrasing:
intent: Add a surface to a product app
effect: write
questions:
- How do I embed my app in a page or the clinical chart with a source URL?
- Can I give a new app surface an icon and label?
instructions:
- text: Add a {type} surface to product {product_id}'s app loading {source_url}.
slots:
type: requestBody.type
product_id: path.product_id
source_url: requestBody.source_url
- text: Create a {type} app surface on product {product_id} from {source_url} with label {core_page_icon_label}.
slots:
type: requestBody.type
product_id: path.product_id
source_url: requestBody.source_url
core_page_icon_label: requestBody.core_page_icon_label
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/app/surfaces/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a surface from a product app
effect: destructive
questions:
- Is there a way to remove an embedded surface from my product's app?
- Can I delete an app surface I no longer use?
instructions:
- text: Delete app surface {id} from product {product_id}.
slots:
id: path.id
product_id: path.product_id
- text: Remove surface {id} from product {product_id}'s app.
slots:
id: path.id
product_id: path.product_id
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/app/surfaces/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Edit an existing app surface
effect: write
questions:
- How do I change the source URL of an app surface already created?
- Can I rename the settings label or chart icon on an existing surface?
instructions:
- text: Change the source URL of surface {id} on product {product_id} to {source_url}.
slots:
id: path.id
product_id: path.product_id
source_url: requestBody.source_url
- text: Set the settings label of app surface {id} on product {product_id} to {settings_label}.
slots:
id: path.id
product_id: path.product_id
settings_label: requestBody.settings_label
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.