Skip to main content
POST
/
api
/
v2
/
brand-voice
/
create
Create Brand Voice
curl --request POST \
  --url https://app.octavehq.com/api/v2/brand-voice/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data @- <<EOF
{
  "title": "Enterprise Brand Voice",
  "description": "Professional and authoritative tone for enterprise audiences",
  "personality": {
    "coreTraits": [
      "Professional",
      "Authoritative",
      "Empathetic"
    ],
    "guidingPrinciples": [
      "Clarity over cleverness",
      "Lead with value"
    ]
  },
  "tonality": {
    "soundLike": [
      "Confident expert",
      "Trusted advisor"
    ],
    "neverSoundLike": [
      "Pushy salesperson",
      "Corporate jargon"
    ]
  },
  "vocabulary": {
    "keyCompanyTerms": [
      "Octave",
      "knowledge graph",
      "GTM intelligence"
    ],
    "keySubstitutions": [
      "Say 'revenue team' not 'sales team'"
    ]
  },
  "writingRules": {
    "languageRules": [
      "Use active voice",
      "Avoid passive constructions"
    ],
    "formattingFundamentals": [
      "Short paragraphs",
      "Bullet points for lists"
    ]
  },
  "audienceConsiderations": {
    "qualitiesAndCharacteristics": [
      "Technical decision makers",
      "Data-driven professionals"
    ],
    "aspirationsAndBoundaries": [
      "Want actionable insights",
      "No fluff or filler"
    ]
  },
  "essence": "Clear, concise, and confident"
}
EOF
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "name": "<string>",
    "deletedAt": "<string>",
    "data": {
      "title": "Enterprise Brand Voice",
      "description": "Professional and authoritative tone for enterprise audiences",
      "personality": {
        "coreTraits": [
          "Professional",
          "Authoritative",
          "Empathetic"
        ],
        "guidingPrinciples": [
          "Clarity over cleverness",
          "Lead with value"
        ]
      },
      "tonality": {
        "soundLike": [
          "Confident expert",
          "Trusted advisor"
        ],
        "neverSoundLike": [
          "Pushy salesperson",
          "Corporate jargon"
        ]
      },
      "vocabulary": {
        "keyCompanyTerms": [
          "Octave",
          "knowledge graph",
          "GTM intelligence"
        ],
        "keySubstitutions": [
          "Say 'revenue team' not 'sales team'"
        ]
      },
      "writingRules": {
        "languageRules": [
          "Use active voice",
          "Avoid passive constructions"
        ],
        "formattingFundamentals": [
          "Short paragraphs",
          "Bullet points for lists"
        ]
      },
      "audienceConsiderations": {
        "qualitiesAndCharacteristics": [
          "Technical decision makers",
          "Data-driven professionals"
        ],
        "aspirationsAndBoundaries": [
          "Want actionable insights",
          "No fluff or filler"
        ]
      },
      "essence": "Clear, concise, and confident",
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "default": false,
    "user": {
      "oId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "workspace": {
      "oId": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api_key
string
header
required

Body

application/json
title
string
required

The name/title of the brand voice

Example:

"Enterprise Brand Voice"

description
string
required

High-level description of this brand voice

Example:

"Professional and authoritative tone for enterprise audiences"

personality
object
required

Brand personality definition

tonality
object
required

Brand tonality guidelines

vocabulary
object
required

Vocabulary preferences and terminology

writingRules
object
required

Writing style and formatting rules

audienceConsiderations
object
required

Target audience considerations

essence
string | null

The core essence or soul of the brand voice

Example:

"Clear, concise, and confident"

Response

Created brand voice

_metadata
object
required
data
object
required