Skip to main content

What Is Brand Voice API?

Brand Voice API allows developers and automation systems to programmatically create, manage, update, and delete brand voices used across Kyrios AI features like Content AI and AI Agents.

What the Brand Voice API Does

The Brand Voice API provides programmatic access to brand voice management inside Kyrios. Using the API, you can:

  • Create brand voices automatically

  • Retrieve brand voice details

  • Update brand messaging and tone

  • Delete unused brand voices

  • Set a default brand voice for an account

  • Standardize AI-generated messaging across systems

Brand voices created through the API work across Kyrios AI-powered features, including:

  • Content AI

  • AI Agents

  • Voice AI

  • Automated messaging workflows


Key Benefits of Brand Voice API

Automation at Scale

Automatically create and manage brand voices across multiple accounts without manual setup.

Flexible Creation Methods

Generate brand voices using:

  • Manual brand inputs

  • Website URLs

  • Text-based business descriptions

Consistent AI Messaging

Maintain consistent tone, audience targeting, and messaging across AI-generated content.

Integration-Friendly

Connect Kyrios with:

  • CRMs

  • Client onboarding systems

  • External SaaS platforms

  • Workflow automations

  • Third-party applications

Dynamic Updates

Update brand voice settings instantly as a business evolves.


Available Brand Voice API Endpoints

Get All Brand Voices

GET /locations/:locationId/voices

Retrieve a list of brand voices for an account.

Supports:

  • Pagination

  • Search

  • Filtering

  • Deleted record visibility


Get a Specific Brand Voice

GET /locations/:locationId/voices/:brandVoiceId

Retrieve complete details for a single brand voice.


Create a Brand Voice

POST /locations/:locationId/voices

Create a new brand voice using one of the supported creation modes.


Update a Brand Voice

PATCH /locations/:locationId/voices/:brandVoiceId

Update an existing brand voice. All fields are optional during updates. Only submitted fields will be modified.


Delete a Brand Voice

DELETE /locations/:locationId/voices/:brandVoiceId

Delete a brand voice from the account.


Set Default Brand Voice

POST /locations/:locationId/voices/:brandVoiceId/default

Set a specific brand voice as the default for the account.


Brand Voice Creation Modes

Kyrios supports multiple brand voice creation methods depending on how much information is available.


Manual Mode (manual)

Manual mode allows full control over brand voice configuration.

Required Fields

  • brandName

  • toneOfVoice

  • targetAudience

  • customerPainPoints

Best Use Cases

Use Manual Mode when:

  • You need precise messaging control

  • Brand standards are already defined

  • AI-generated analysis is not desired

  • You want highly customized outputs


URL Mode (url)

URL mode generates a brand voice using website analysis.

How It Works

  1. Submit a website URL

  2. Kyrios AI scans the site

  3. Brand voice data is generated automatically

Best Use Cases

Use URL Mode when:

  • Onboarding new clients quickly

  • Migrating existing brands into Kyrios

  • A business already has a developed website presence


Description Mode (description)

Description mode generates a brand voice using a written business summary.

How It Works

  1. Submit a text description of the business

  2. Kyrios AI analyzes the description

  3. Brand voice details are generated automatically

Best Use Cases

Use Description Mode when:

  • A website is not available

  • The business is new

  • You need rapid AI-assisted setup


Validation Rules and Requirements

Understanding validation rules helps prevent API errors during creation and updates.


Required Field on Brand Voice Creation

The type field is required during creation.

Supported values:

  • manual

  • url

  • description


Manual Mode Validation Rules

When using manual mode, these fields are required:

  • brandName

  • toneOfVoice

  • targetAudience

  • customerPainPoints


URL and Description Mode Restrictions

URL Mode Restrictions

  • Manual answer fields cannot be included

  • Only URL-based input should be submitted

Description Mode Restrictions

  • Manual answer fields should not be included

  • Only description-based input should be submitted


Invalid Field Combination Rules

Invalid Manual Fields

Manual fields cannot be submitted when using:

  • url

  • description

creation types.


Invalid URL Usage

The url field cannot be used with manual type.


Update Behavior

Brand voice updates use partial update behavior.

Important Update Rules

  • All fields are optional during updates

  • Only submitted fields are modified

  • Existing fields remain unchanged if omitted


Common Issues and Fixes

Error: Invalid Fields for Creation Type

Cause: Fields were submitted that do not match the selected creation mode.

Fix: Ensure fields match the selected type.

Example:

  • Do not send manual fields with url

  • Do not send url with manual

Error: Missing Required Manual Fields

Cause: A required field was omitted during manual creation.

Fix: Ensure all required manual fields are included:

  • brandName

  • toneOfVoice

  • targetAudience

  • customerPainPoints

Error: Brand Voice Not Updating

Cause: PATCH requests only modify submitted fields.

Fix: Verify the intended fields are included in the request payload.

FAQ

Can I create multiple brand voices for one account?

Yes. Kyrios supports multiple brand voices per account, and one can be set as the default.

When should I use manual mode instead of AI-generated modes?

Use manual mode when you need full control over tone, messaging, and audience positioning. Use URL or description modes for faster AI-assisted setup.

Can I update only one field in a brand voice?

Yes. PATCH requests support partial updates, so only submitted fields are changed.

What happens if I submit invalid fields for a creation mode?

The API returns a validation error if the submitted fields do not match the selected creation type.

Can deleted brand voices be recovered?

Recovery behavior may depend on system implementation. Confirm before deleting important brand voices.

Do API-created brand voices work with Content AI and AI Agents?

Yes. Brand voices created through the API are fully compatible with Kyrios AI-powered features.

Does Brand Voice API support automation workflows?

Yes. Brand Voice API can be integrated into onboarding systems, workflows, external applications, and automation pipelines.

Did this answer your question?