Learn a brand voice from past posts
POST/:workspaceUuid/brand-voice/learn
Reads the workspace's latest published posts (original text) and proposes a brand voice in the
same shape as GET /brand-voice. Returns a draft and saves nothing unless apply: true.
Without overwrite, learned values only fill fields that are empty (tone sliders and styles
still at their defaults count as empty); with overwrite: true they replace them. The first
five sampled posts become example_posts. Needs at least 3 published posts (422,
code: not_enough_posts). Costs one AI text credit per AI call (one retry when the reply is
not usable). Admins and members only. A key limited to some accounts must send account_ids;
only posts whose accounts are all among them are read. apply also needs the write ability.
Request
Responses
- 200
- 401
- 403
- 422
- 429
- 502
Proposed (or saved) brand voice
Missing or invalid API token.
Not allowed. Either the caller is not a workspace admin (or not a member), or a scoped API key
lacks the ability or workspace for this call (code: insufficient_scope).
Validation error, AI disabled, or fewer than 3 published posts (code: not_enough_posts)
AI text credits used up (code: ai_credits_exhausted)
The AI reply was not a usable profile (code: ai_unusable_response)