rest api
the rest api exposes voice analysis, rewriting, profiles, usage, and document endpoints under `/v1/`. every request uses a bearer api key.
quick answer
use the api when a workflow should call hold your voice without opening the web app.
use this for
- automating voice checks
- creating documents from another tool
- building an internal client
steps
- create an api key.
- send `authorization: bearer <key>` on each request.
- call `/v1/profiles` if the user has multiple brands.
- call `/v1/analyze` or `/v1/rewrite` with a brand when needed.
- call `/v1/usage` to check quota.
details to know
- `post /v1/analyze` returns highlights, signal delta, trust tools, profile id, remaining quota, and cost attribution.
- `post /v1/rewrite` returns one rewritten passage.
- `get /v1/profiles` lists own and team profiles.
- `get /v1/usage` returns quota and per-brand 30-day token breakdown.
- document endpoints can list, create, read, update, and delete documents.
limits and edge cases
- text limits apply to analyze and rewrite.
- ambiguous brand names return candidates instead of guessing.
- expired accounts cannot use paid rewrite endpoints.
ready to use the product instead of reading about it?
open app