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>'
import requests

url = "https://app.octavehq.com/api/v2/brand-voice/get"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.octavehq.com/api/v2/brand-voice/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/brand-voice/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api_key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://app.octavehq.com/api/v2/brand-voice/get"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("api_key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/brand-voice/get")
.header("api_key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/brand-voice/get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "_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": "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>"
  }
}
{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<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 | null
default
boolean
default:false

Whether this is the default brand voice for the workspace

user
object | null

User data

workspace
object | null

Workspace data