profile resolution
api and mcp calls can target a voice profile by uuid, slug, name, business name, `profile`, `brand`, or legacy `profile_id`.
quick answer
use profile resolution when one account has multiple brands.
use this for
- choosing the right brand in api calls
- handling ambiguous profile names
- building ai assistant workflows
steps
- call `/v1/profiles` or `hyv_list_profiles`.
- pick the exact profile name, slug, or id.
- pass it as `brand` in analyze, rewrite, or create-document calls.
- if the api returns ambiguity, ask the user to choose a candidate.
details to know
- own and team-shared profiles can both be resolved.
- slug is the safest human-readable key.
- ambiguous profile matches return a structured `profile_ambiguous` error with candidates.
limits and edge cases
- the api should not silently choose between two close matches.
- profile ids from another account are not accepted.
ready to use the product instead of reading about it?
open app