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 Backend API
version: 1.0.0
extends: openapi/hint-health-backend-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/backends'].get
update:
x-apievangelist-phrasing:
intent: List partner backends
effect: read
questions:
- Which backends does my partner account have?
- Can I list partner backends created after a certain date?
instructions:
- text: List my partner backends.
- text: List backends created since {created_at}.
slots:
created_at: query.created_at
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/backends/{id}'].get
update:
x-apievangelist-phrasing:
intent: Look up a partner backend
effect: read
questions:
- What webhook and OAuth settings does a specific backend have?
- Can I see the configuration of one partner backend?
instructions:
- text: Show partner backend {id}.
slots:
id: path.id
- text: Get the OAuth and webhook config for backend {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/backends/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a partner backend's settings
effect: write
questions:
- Can I pause webhook delivery for one of my backends?
- Is it possible to change the OAuth redirect URL on a backend?
- Can I limit how many requests per minute a backend allows?
instructions:
- text: Pause webhooks on backend {id} by setting webhooks_paused to {webhooks_paused}.
slots:
id: path.id
webhooks_paused: requestBody.webhooks_paused
- text: Set the redirect URL for backend {id} to {redirect_url}.
slots:
id: path.id
redirect_url: requestBody.redirect_url
- text: Change backend {id} to listen for events {listened_events}.
slots:
id: path.id
listened_events: requestBody.listened_events
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.