Skip to main content
POST
/
api
/
v2
/
brand-voice
/
generate
Generate Brand Voice
curl --request POST \
  --url https://app.octavehq.com/api/v2/brand-voice/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "<string>",
  "sources": [
    {
      "type": "TEXT",
      "value": "Lead generation and qualification for enterprise sales"
    }
  ]
}
'
import requests

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

payload = {
    "name": "<string>",
    "sources": [
        {
            "type": "TEXT",
            "value": "Lead generation and qualification for enterprise sales"
        }
    ]
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    sources: [
      {type: 'TEXT', value: 'Lead generation and qualification for enterprise sales'}
    ]
  })
};

fetch('https://app.octavehq.com/api/v2/brand-voice/generate', 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/generate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'sources' => [
        [
                'type' => 'TEXT',
                'value' => 'Lead generation and qualification for enterprise sales'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"sources\": [\n    {\n      \"type\": \"TEXT\",\n      \"value\": \"Lead generation and qualification for enterprise sales\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/brand-voice/generate")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"sources\": [\n    {\n      \"type\": \"TEXT\",\n      \"value\": \"Lead generation and qualification for enterprise sales\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"sources\": [\n    {\n      \"type\": \"TEXT\",\n      \"value\": \"Lead generation and qualification for enterprise sales\"\n    }\n  ]\n}"

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

Authorizations

api_key
string
header
required

Body

application/json
name
string
required

Name for the brand voice

sources
object[]
required

Source materials to analyze for brand voice generation

Response

Created brand voice

_metadata
object
required
data
object
required