Hint Health

Hint Health App Surface API

The AppSurface API from Hint Health — 2 operation(s) for appsurface.

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /partner/products/{product_id}/app/surfaces Add a surface to a product app · Create App Surface #
Ask an LLM
“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?”
Tell an agent
Add a {type} surface to product {product_id}'s app loading {source_url}.
Create a {type} app surface on product {product_id} from {source_url} with label {core_page_icon_label}.
PATCH /partner/products/{product_id}/app/surfaces/{id} Edit an existing app surface · Update App Surface #
Ask an LLM
“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?”
Tell an agent
Change the source URL of surface {id} on product {product_id} to {source_url}.
Set the settings label of app surface {id} on product {product_id} to {settings_label}.
DELETE /partner/products/{product_id}/app/surfaces/{id} Remove a surface from a product app · Delete App Surface #
Ask an LLM
“Is there a way to remove an embedded surface from my product's app?”
“Can I delete an app surface I no longer use?”
Tell an agent destructive · confirm first
Delete app surface {id} from product {product_id}.
Remove surface {id} from product {product_id}'s app.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/hint-health/refs/heads/main/openapi/hint-health-appsurface-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hint-health/refs/heads/main/json-schema/hint-health-partner-partner-product-apps-surfaces-controller-create-body-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hint-health/refs/heads/main/json-schema/hint-health-partner-partner-product-apps-surfaces-controller-update-body-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hint-health/refs/heads/main/json-schema/hint-health-public-app-surface-blueprint-one-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/hint-health:hint-health-appsurface-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

hint-health-appsurface-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '2026-07-01'
  title: Partner Endpoints App Surface API
  description: Hint Health API
  contact:
    name: Hint
    email: devsupport@hint.com
    url: https://developers.hint.com
  license:
    name: Private
  termsOfService: https://www.hint.com/terms
  x-api-evangelist-harvest:
    generated: '2026-08-15'
    method: searched
    source: https://developers.hint.com/reference/<slug>.md (204 pages indexed by https://developers.hint.com/llms.txt)
    note: 'Assembled from the per-endpoint OpenAPI 3.1 documents Hint publishes verbatim inside each ReadMe reference page''s ''# OpenAPI definition'' fenced JSON block. Every path item, schema, tag and server value is Hint''s own text; only the union of paths and components was computed. Ownership is not in question: info.title ''Partner Endpoints'', info.contact devsupport@hint.com, info.termsOfService https://www.hint.com/terms and servers api.sandbox.hint.com all name Hint Health.'
    pages_fetched: 204
    pages_carrying_a_spec: 200
    operations: 200
    supersedes: openapi/_original/hint-health-hint-health-api-openapi.yml (harvested 2026-06-13, 153 operations)
    follow_up: NOT yet split into per-tag specs and deliberately NOT wired into apis.yml — the 49 refined specs in openapi/ still derive from the June harvest. Re-run refine-openapis to re-split from this document and pick up the 47 operations the catalogue is missing (appointments, appointment types, communication authorizations, the partner-invisible clinical chart endpoints, and the products/installations/backends marketplace surface).
servers:
- url: https://api.sandbox.hint.com/api
tags:
- name: AppSurface
  description: ''
paths:
  /partner/products/{product_id}/app/surfaces:
    post:
      tags:
      - AppSurface
      operationId: AppSurface.CreateProductAppSurface
      summary: Create App Surface
      description: ''
      parameters:
      - name: product_id
        in: path
        required: true
        description: Unique Product ID
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Public.AppSurfaceBlueprint_one'
              example:
                id: panch-ab12C345DeF6
                source_url: https://hint-partner-emr.com/hint/core_page
                localhost_source_url: http://localhost:3000/hint/core_page
                type: core_page
                core_page_icon_url: null
                core_page_icon_label: Partner EMR
                core_page_auto_adjust_height: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Partner.PartnerProductApps.SurfacesController.create_body'
  /partner/products/{product_id}/app/surfaces/{id}:
    patch:
      tags:
      - AppSurface
      operationId: AppSurface.UpdateProductAppSurface
      summary: Update App Surface
      description: ''
      parameters:
      - name: product_id
        in: path
        required: true
        description: Unique Product ID
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique App Surface ID
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Public.AppSurfaceBlueprint_one'
              example:
                id: panch-ab12C345DeF6
                source_url: https://hint-partner-emr.com/hint/core_page
                localhost_source_url: http://localhost:3000/hint/core_page
                type: core_page
                core_page_icon_url: null
                core_page_icon_label: Partner EMR
                core_page_auto_adjust_height: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Partner.PartnerProductApps.SurfacesController.update_body'
    delete:
      tags:
      - AppSurface
      operationId: AppSurface.DeleteProductAppSurface
      summary: Delete App Surface
      description: ''
      parameters:
      - name: product_id
        in: path
        required: true
        description: Unique Product ID
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique App Surface ID
        schema:
          type: string
      responses:
        '200':
          description: Successful response
components:
  schemas:
    Public.AppSurfaceBlueprint_one:
      type: object
      properties:
        id:
          type: string
        source_url:
          type: string
        localhost_source_url:
          type: string
        type:
          type: string
        interaction_title:
          type: string
        interaction_description:
          type: string
        interaction_type:
          type: string
        core_page_icon_url:
          type: string
        core_page_icon_label:
          type: string
        core_page_auto_adjust_height:
          type: boolean
        clinical_chart_icon_url:
          type: string
        clinical_chart_icon_label:
          type: string
        settings_label:
          type: string
    Partner.PartnerProductApps.SurfacesController.create_body:
      title: Create_AppSurface
      type: object
      properties:
        type:
          type: string
          enum:
          - core_page
          - clinical_interaction
          - clinical_chart
          - settings
        source_url:
          type: string
        localhost_source_url:
          type: string
          description: HTTP localhost URL used in place of `source_url` when the requesting browser session has localhost mode enabled. Sandbox partners only.
        core_page_icon:
          type: string
          description: Base64-encoded data URI of the icon image (e.g. `data:image/png;base64,...`). Max 5MB. Used only for `core_page` surfaces. **Note the field-name asymmetry:** the request field is `core_page_icon` (data URI input); the GET response surfaces the uploaded image as `core_page_icon_url` (hosted URL). Sending `core_page_icon_url` as a request field is silently ignored.
        core_page_icon_label:
          type: string
          description: Sidebar text shown next to the icon — tooltip on hover on desktop, visible text on mobile sidebars. Recommended ≤14 characters (longer labels overflow the nav rail). Used only for `core_page` surfaces.
        core_page_auto_adjust_height:
          type: boolean
        interaction_title:
          type: string
        interaction_description:
          type: string
        interaction_type:
          type: string
        clinical_chart_icon:
          type: string
          description: Base64-encoded data URI of the icon image (e.g. `data:image/png;base64,...`). Max 5MB. Used only for `clinical_chart` surfaces. **Note the field-name asymmetry:** the request field is `clinical_chart_icon` (data URI input); the GET response surfaces the uploaded image as `clinical_chart_icon_url` (hosted URL). Sending `clinical_chart_icon_url` as a request field is silently ignored.
        clinical_chart_icon_label:
          type: string
          description: Sidebar text shown next to the icon — tooltip on hover on desktop, visible text on mobile sidebars. Recommended ≤14 characters. Used only for `clinical_chart` surfaces.
        settings_label:
          type: string
      required:
      - type
      - source_url
    Partner.PartnerProductApps.SurfacesController.update_body:
      title: Update_AppSurface
      type: object
      properties:
        source_url:
          type: string
        localhost_source_url:
          type: string
          description: HTTP localhost URL used in place of `source_url` when the requesting browser session has localhost mode enabled. Sandbox partners only.
        core_page_icon:
          type: string
          description: Base64-encoded data URI of the icon image (e.g. `data:image/png;base64,...`). Max 5MB. Used only for `core_page` surfaces. **Note the field-name asymmetry:** the request field is `core_page_icon` (data URI input); the GET response surfaces the uploaded image as `core_page_icon_url` (hosted URL). Sending `core_page_icon_url` as a request field is silently ignored.
        core_page_icon_label:
          type: string
          description: Sidebar text shown next to the icon — tooltip on hover on desktop, visible text on mobile sidebars. Recommended ≤14 characters (longer labels overflow the nav rail). Used only for `core_page` surfaces.
        core_page_auto_adjust_height:
          type: boolean
        interaction_title:
          type: string
        interaction_description:
          type: string
        interaction_type:
          type: string
        clinical_chart_icon:
          type: string
          description: Base64-encoded data URI of the icon image (e.g. `data:image/png;base64,...`). Max 5MB. Used only for `clinical_chart` surfaces. **Note the field-name asymmetry:** the request field is `clinical_chart_icon` (data URI input); the GET response surfaces the uploaded image as `clinical_chart_icon_url` (hosted URL). Sending `clinical_chart_icon_url` as a request field is silently ignored.
        clinical_chart_icon_label:
          type: string
          description: Sidebar text shown next to the icon — tooltip on hover on desktop, visible text on mobile sidebars. Recommended ≤14 characters. Used only for `clinical_chart` surfaces.
        settings_label:
          type: string
  securitySchemes:
    hint_api_key:
      type: apiKey
      name: AUTHORIZATION
      in: header
      description: 'Enter your token in the format: `Bearer {your_api_key}`'