Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints App API

4 actions 4 updates phrasing extends openapi/hint-health-app-api-openapi.yml
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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/partner/products/{product_id}/app'].get
$.paths['/partner/products/{product_id}/app'].post
$.paths['/partner/products/{product_id}/app'].patch

OpenAPI Overlay

Raw ↑
# 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 API
  version: 1.0.0
extends: openapi/hint-health-app-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'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product's embedded app settings
      effect: read
      questions:
      - What app configuration sits behind one of my products?
      - What handshake URL and role mappings does my product's app use?
      instructions:
      - text: Show the app for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Get product {product_id}'s app handshake URL and roles.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/app'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an embedded app for a product
      effect: write
      questions:
      - How do I set up an app with a handshake URL for my product?
      - Can I define partner roles and default role mappings when creating the app?
      instructions:
      - text: Create an app for product {product_id} with handshake URL {handshake_url}.
        slots:
          product_id: path.product_id
          handshake_url: requestBody.handshake_url
      - text: Create product {product_id}'s app with default admin role {default_admin_role} and non-admin role {default_non_admin_role}.
        slots:
          product_id: path.product_id
          default_admin_role: requestBody.default_admin_role
          default_non_admin_role: requestBody.default_non_admin_role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/app'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a product app's handshake or roles
      effect: write
      questions:
      - How do I change the handshake URL on my product's existing app?
      - Can I update the browser allow list for an app I already set up?
      instructions:
      - text: Update the handshake URL of product {product_id}'s app to {handshake_url}.
        slots:
          product_id: path.product_id
          handshake_url: requestBody.handshake_url
      - text: Set the browser allow list on product {product_id}'s app to {browser_allow_list}.
        slots:
          product_id: path.product_id
          browser_allow_list: requestBody.browser_allow_list
      - text: Change the local development handshake URL of product {product_id}'s app to {localhost_handshake_url}.
        slots:
          product_id: path.product_id
          localhost_handshake_url: requestBody.localhost_handshake_url
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/hint-health-app-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

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.

A second provider on the same verified email joins the account you already have.