Skip to main content
POST
Create Voice

Authorizations

X-API-Key
string
header
required

API Key for authentication

Body

application/json
name
string
required

Short human-readable Voice name (e.g., 'Founder voice', 'Casual replies'). Required.

Minimum string length: 1
userId
string<uuid>
required

ID of the user that will own the new Voice. Usually the current user. Required.

backgroundAboutUser
string

Free-form plain text about the user themselves — role, background, perspective. Used as background when generating comments and direct messages, and when analyzing incoming posts. Optional — may be added later.

backgroundAboutCompany
string

Free-form plain text about the user's company, product, market, and target audience. Used as background when generating comments and direct messages, and when analyzing incoming posts. Optional — may be added later.

instructionsForComments
string

Free-form plain text with tone instructions for comment generation (tone, structure, do/don't). Used only when generating comments, not direct messages. Optional — may be added later.

instructionsForDm
string

Free-form plain text with tone instructions for direct-message generation (tone, structure, do/don't). Used only when generating direct messages, not comments. Optional — may be added later.

isLearningModeEnabled
boolean

Whether the Voice is in learning mode. When true, the backend auto-saves as Comment Examples only those comments the user both approved AND edited before approval (unchanged auto-approved comments are NOT saved). Only comments are learned — direct messages are never auto-saved. The Voice's Comment Examples are capped at 20 entries; auto-saved and manual entries share the same 20-slot cap. When false, no auto-learning happens and existing Comment Examples keep being used as-is. Optional — omit to leave auto-learning off.

Response

status
enum<string>
required

Response status

Available options:
success
data
object
required
message
string
required

Success message

Example:

"Operation completed successfully"