Skip to main content
POST
/
brand-voices
cURL
curl -X POST https://app.mavera.io/api/v1/brand-voices \
  -H "Authorization: Bearer mvra_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Acme Brand Voice",
    "urls": ["https://acme.com/about", "https://acme.com/blog"],
    "usage_context": "Marketing content and social media"
  }'
{
  "id": "<string>",
  "object": "brand_voice",
  "label": "<string>",
  "usage_context": "<string>",
  "status": "pending",
  "error": "<string>",
  "voice_summary": "<string>",
  "tone": {
    "adjectives": [
      "<string>"
    ],
    "dos": [
      "<string>"
    ],
    "donts": [
      "<string>"
    ]
  },
  "writing_style": {
    "sentence_structure": "<string>",
    "jargon_usage": "<string>"
  },
  "vocabulary": {
    "preferred_terms": [
      "<string>"
    ],
    "avoid_terms": [
      "<string>"
    ]
  },
  "example_phrases": [
    {
      "use_case": "<string>",
      "example": "<string>"
    }
  ],
  "sources": {
    "urls": [
      {
        "id": "<string>",
        "url": "<string>",
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "documents": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "file_type": "<string>",
        "file_size": 123
      }
    ]
  },
  "workspace_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key prefixed with mvra_live_. Create keys at Settings > Developer > API Keys.

Body

application/json
label
string
required

Display name for the brand voice

Minimum string length: 2
usage_context
string
required

Description of how this brand voice will be used

Minimum string length: 10
workspace_id
string

Target workspace ID (uses default workspace if not specified)

urls
object[]

URLs to analyze for brand voice extraction

documents
object[]

Documents to analyze for brand voice extraction

user_examples
object[]

Example phrases you want the brand voice to use

user_vocabulary
object

Vocabulary preferences

user_tone
object

Tone preferences

Response

Brand voice created successfully. Status will be 'pending' until processing completes.

A brand voice profile for content generation

id
string

Unique brand voice identifier

object
enum<string>
Available options:
brand_voice
label
string

Display name for the brand voice

usage_context
string

Description of how this brand voice should be used

status
enum<string>

Current processing status of the brand voice

Available options:
pending,
generating,
completed,
failed
error
string | null

Error message if status is failed

voice_summary
string | null

AI-generated summary of the brand voice

tone
object

Tone guidelines for the brand voice

writing_style
object

Writing style guidelines

vocabulary
object

Vocabulary preferences

example_phrases
object[] | null

Example phrases demonstrating the brand voice

sources
object

Source materials used to generate the brand voice

workspace_id
string
created_at
string<date-time>
updated_at
string<date-time>