rest api profiles
profile endpoints let integrations list available voices and choose the right one before analysis or rewriting. this prevents generic output and wrong-brand edits.
quick answer
read profiles before acting when the account may contain more than one brand voice.
use this for
- multi-brand integrations
- agent setup screens
- debugging profile not found responses
steps
- send a key with profile read access.
- list the profiles available to the account.
- show profile names to the user when a choice is needed.
- store the selected profile id only for that user's authorized workflow.
- pass that id to analyze or rewrite calls.
details to know
- profiles represent writing voices, not billing plans.
- a profile id is safer than a loose brand name once the user has chosen.
- profile listing should be read-only unless a future write workflow is explicitly supported.
limits and edge cases
- do not expose profiles from other accounts.
- do not assume the first profile is always the right one.
- profile write scope should stay off unless the integration really edits profiles.
ready to use the product instead of reading about it?
open app