Skip to main content
GET
/
api
/
v2
/
brand-voice
/
get
Get Brand Voice
curl --request GET \
  --url https://app.octavehq.com/api/v2/brand-voice/get \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "oId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "name": "<string>",
  "deletedAt": "<string>",
  "data": {
    "title": "<string>",
    "description": "<string>",
    "personality": {
      "coreTraits": [
        "<string>"
      ],
      "guidingPrinciples": [
        "<string>"
      ]
    },
    "tonality": {
      "soundLike": [
        "<string>"
      ],
      "neverSoundLike": [
        "<string>"
      ]
    },
    "vocabulary": {
      "keyCompanyTerms": [
        "<string>"
      ],
      "keySubstitutions": [
        "<string>"
      ]
    },
    "writingRules": {
      "languageRules": [
        "<string>"
      ],
      "formattingFundamentals": [
        "<string>"
      ]
    },
    "audienceConsiderations": {
      "qualitiesAndCharacteristics": [
        "<string>"
      ],
      "aspirationsAndBoundaries": [
        "<string>"
      ]
    },
    "essence": "<string>",
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "default": false,
  "user": {
    "oId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "workspace": {
    "oId": "<string>"
  }
}

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Brand Voice OId

Response

Brand Voice data

_metadata
object
required
oId
string
required

Brand Voice OId

createdAt
string | null
required

Creation date

updatedAt
string | null
required

Updated date

name
string
required

Brand Voice name

deletedAt
string | null

Deleted date

data
object
default
boolean
default:false

Whether this is the default brand voice for the workspace

user
object

User data

workspace
object

Workspace data