rest api analyze
the analyze endpoint checks text against a voice profile and returns score, highlights, ai-pattern evidence, trust signals, and voice guidance for downstream workflows.
quick answer
call analyze when the user needs to understand what is wrong before changing the draft.
use this for
- checking text from another app
- running a backend voice review
- giving an agent structured critique before rewrite
steps
- send a bearer api key with the `analyze` scope.
- send the text and the intended profile or brand.
- read the score, highlights, and issue groups.
- show the user the highest-impact issues first.
- call rewrite only for selected text that should change.
details to know
- analysis combines ai-pattern detection, voice-profile matching, signal checks, and trust-tool evidence.
- the response is meant to be machine-readable enough for an agent and plain enough for user explanation.
- profile selection matters more than generic tone labels.
limits and edge cases
- empty or tiny text cannot produce a useful analysis.
- the endpoint needs the right scope and an allowed plan.
- agents should not rewrite the whole draft just because analysis returned issues.
ready to use the product instead of reading about it?
open app