hold your voice wiki
one clean map for the product. every page explains what a feature does, when to use it, what can go wrong, and where to go next.
read this first
the wiki is intentionally practical. these four pages cover the app map, the voice profile, the editor check, and the integration entry point.
01product overview
start here if you need the plain english map of the whole product before reading the feature pages.
02voice profile overviewread this before changing profile behavior or explaining scoring.
03run a voice checkrun a check when the draft is ready enough to judge.
04api keyscreate one key per integration so it can be revoked without breaking everything.
all docs
browse by product area. each page stays short enough for a person to scan and structured enough for an ai assistant to cite accurately.
01
start here
3 pages02
accounts
12 pages- sign up and loginuse google for the fastest path, or use email and password when the user wants a direct account.
- change emailopen the profile menu, choose change beside the email, send the code, and confirm it.
- account settingsuse the avatar menu in the top right of the app to manage account-level settings.
- avatar pickeropen the profile menu, click the avatar, choose a generated face, then save it.
- mobile reminderuse this when a user asks why the editor is not fully available on mobile.
- sessions and devicesrevoke old sessions when a device is lost, shared, or no longer trusted.
- password reset and session securityuse forgot password when the user cannot sign in, and expect old sessions to be treated carefully afterward.
- delete account and datadelete the account only when the user clearly wants to leave and understands the data impact.
- email notificationsemails should explain a real product event and give the user a simple next step.
- unsubscribeuse unsubscribe for marketing or digest-style email, not for account security events.
- weekly voice digestread the digest as a progress summary, not as the source of truth for every draft.
- mobile desktop reminder flowthe reminder flow should move users from phone discovery to desktop work without pretending the mobile screen is the full app.
03
voice profile
13 pages- onboardingfinish onboarding once per account or per new brand profile.
- build your first voice profilebuild one profile before checking serious drafts.
- voice profile overviewread this before changing profile behavior or explaining scoring.
- flashcard voice profilechoose this path when speed matters more than precision.
- paste a voice profileuse this path when the brand already has voice notes.
- edit your voice profileedit the profile when highlights feel off or the brand voice has changed.
- writing samplesadd samples when rewrites need to sound closer to the user's real writing.
- use a document as a sampleuse this when a finished draft clearly represents the user's real voice.
- reanalyze voice profilereanalyze after at least three solid samples are stored.
- voice profile readinesswhen feedback feels too generic, improve readiness before rewriting more text.
- voice lessons from regeneratesaccepted rewrites teach more than ignored rewrites because they show what the user actually preferred.
- suggestion events and learning loopthe product learns from repeated user behavior, so the best signal is honest action on each suggestion.
- drift thresholds and proposalsreview a proposal as a possible profile update, not as proof that the profile is wrong.
04
documents
14 pages- dashboarduse the dashboard to find, create, filter, delete, star, and export documents.
- create your first documentclick new document, paste or write, then let autosave create the record.
- editorwrite or paste the draft, choose a format, run a check, then fix only what matters.
- document formatschoose the format before running a serious check.
- editor toolbaruse the toolbar for document structure before copying or sharing.
- autosave history and undowrite normally. the app saves after short pauses and before tab close.
- copy final textuse copy text after accepting the fixes you want.
- search documentstype in dashboard search when you do not remember the exact document title.
- semantic searchuse semantic search when the user remembers the idea but not the exact phrase.
- filters and sortinguse filters when the dashboard has more than a handful of drafts.
- starred documentsstar drafts that are active, approved, or worth revisiting.
- delete documentsdelete only when the user is done with the draft.
- export documentsuse export before cleanup, offboarding, or moving drafts into another system.
- zen modeuse zen mode when the user wants to write without panels and buttons around the draft.
05
voice check
15 pages- run a voice checkrun a check when the draft is ready enough to judge.
- voice scoreuse the score as a direction signal, not as a final verdict.
- signal engineuse it to understand why a draft works or falls flat.
- ai pattern detectoruse it to remove the parts that feel synthetic without rewriting the whole draft.
- highlights and tooltipshover or click a highlight when you need to understand a specific flag.
- rewrite suggestionsuse a rewrite when a flagged line is right in idea but wrong in voice.
- fix alluse fix all only when the flags are clearly correct.
- allow words and rulesuse allow actions when a repeated flag is clearly wrong.
- voice memoryuse voice memory to explain why the app seems to learn from user choices.
- drift proposalsuse this when the app notices a repeated pattern across checks.
- trust toolsuse this page when a score mentions trust or when a draft feels vague.
- profile backed feedbackuse this when a user asks why the app knows a line does or does not sound like them.
- why a highlight appearedopen the tooltip before changing text. the highlight is a signal, not an order.
- rule id referenceuse rule ids when logging, debugging, or explaining a recurring pattern across documents.
- trust tools referenceuse trust tools when the draft sounds polished but still feels empty.
06
analytics
4 pages- analysis pageuse this page to understand long-term voice trend, not one line-level fix.
- insightsuse insights after the account has written enough to show real patterns.
- download insightsuse this when a user wants to post or save their voice summary.
- quote screenuse the quote screen as a small reflective surface, not as the main analysis dashboard.
07
teams
7 pages- brands and profilesuse brand switching when one account writes for more than one voice.
- team overviewuse teams when more than one person writes or reviews in the same workspace.
- invite team memberssend invites when someone needs access to shared team work.
- team roleschoose the least powerful role that still lets the person do the work.
- team document sharinguse team sharing for private collaboration that should not be public.
- collaboration locksuse this page when a teammate sees read-only mode or request edit access.
- team share permissionsuse team sharing for private collaboration. use public sharing for outside review.
08
sharing
12 pages- public sharinguse public sharing when the author wants someone outside the team to read or comment.
- public document pagesuse this when explaining what people see after opening a shared link.
- public commentsuse commentable mode when the author wants outside feedback without creating a team.
- comments paneluse the comments tab to manage feedback without leaving the editor.
- access requestsuse the access page to moderate who can comment.
- public document permissions matrixcheck the permission mode before telling someone they can view, comment, or edit a shared document.
- anonymous commentsuse anonymous comments for lightweight outside feedback, not for controlled team review.
- comment moderationowners moderate the conversation; commenters leave feedback.
- request edit flowuse request edit when the viewer should ask the owner for permission instead of receiving direct edit power.
- version conflicts and read only modewhen the editor becomes read-only, check role, lock, and version state before changing anything.
- document lock heartbeatslocks are temporary signals. wait, request edit, or coordinate with the other editor instead of forcing changes.
- public access emailsaccess emails are part of the permission flow, not marketing email.
09
billing
6 pages- billing planscheck the plan before explaining a missing feature.
- usage and quotasuse this page whenever a user asks what counts against the plan.
- content swap guarduse this when an update is counted as a new document.
- free and expired planuse this page when a user sees an upgrade prompt after trial end.
- what happens after paymentafter a successful upgrade, check plan state first, then guide the user to the feature that opened.
- checkout and customer portaluse checkout to upgrade. use the customer portal to manage an existing paid subscription.
10
byok
5 pages- byok overviewuse byok when the user wants scale and direct provider billing.
- set up anthropic byokuse anthropic when the user wants a direct provider account with claude models.
- set up openrouter byokuse openrouter when the user already runs model spend there.
- set up opencode byokuse opencode when the user wants open go routing for byok usage.
- byok lifetime welcome emailsend lifetime byok users one warm setup email with the byok overview link, not separate links for every provider.
11
api and mcp
19 pages- api keyscreate one key per integration so it can be revoked without breaking everything.
- rest apiuse the api when a workflow should call hold your voice without opening the web app.
- rest api documentsuse these endpoints when external workflows should sync drafts into hold your voice.
- profile resolutionuse profile resolution when one account has multiple brands.
- mcp serveruse mcp when a user wants an ai assistant to check or rewrite drafts in their own workflow.
- browser extensionuse this page for extension-facing product behavior, not public store copy.
- api authentication and bearer keyssend `authorization: bearer hyv_live_...` from a backend, local agent, or secret manager, never from a public browser bundle.
- api key scopesuse narrow scopes for each integration instead of one all-powerful key everywhere.
- api errors and status codestreat the status code as the first routing signal, then read the error field for the exact reason.
- api rate limits and plan gatesif an api or mcp call fails after working before, check rate limit, quota, plan, and key scope in that order.
- well known agent discoveryagents should read the well-known discovery files before assuming which endpoints or tools exist.
- mcp installation and env varsset `HYV_API_KEY` and keep the key in the local mcp configuration, not inside prompts.
- mcp tools referenceuse list or read tools before write tools, and use analyze before rewrite when the draft has not been inspected yet.
- agent brand routingwhen an account has multiple brands, resolve the brand before calling analyze or rewrite.
- rest api analyzecall analyze when the user needs to understand what is wrong before changing the draft.
- rest api rewriterewrite the smallest section that actually needs help, then let the user approve it.
- rest api profilesread profiles before acting when the account may contain more than one brand voice.
- rest api usagecall usage before large batches, then explain any limit in normal product language.
- browser extension auth and limitsextension behavior depends on auth, account plan, and supported browser state.
12
security
1 pages13
support
8 pages- troubleshootingstart here when the symptom is clear but the feature area is not.
- wiki maintenanceupdate the wiki in the same work as the feature change.
- changelog and updatesuse the changelog when a shipped change affects users.
- free tools overviewuse free tools for quick public checks, then move serious voice work into the app.
- tool results and email captureask only for email when it helps deliver or continue the result, not as a surprise gate.
- brand voice analyzer tooluse the public analyzer for a fast diagnosis; use the app for saved, repeatable voice checking.
- ai drift detector tooluse the detector for a quick public check, then use the app when the user wants saved fixes and profile-backed feedback.
- feedback and supportwhen a user is stuck, capture the screen, feature, expected behavior, and what happened instead.
ready to use the product instead of reading about it?
open app