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

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

payload = {
"sources": [
{
"type": "TEXT",
"value": "Lead generation and qualification for enterprise sales"
}
],
"brandVoiceOId": "<string>",
"modelType": "ECHO",
"includeOriginal": False
}
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({
sources: [
{type: 'TEXT', value: 'Lead generation and qualification for enterprise sales'}
],
brandVoiceOId: '<string>',
modelType: 'ECHO',
includeOriginal: false
})
};

fetch('https://app.octavehq.com/api/v2/brand-voice/apply', 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/apply",
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([
'sources' => [
[
'type' => 'TEXT',
'value' => 'Lead generation and qualification for enterprise sales'
]
],
'brandVoiceOId' => '<string>',
'modelType' => 'ECHO',
'includeOriginal' => false
]),
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/apply"

payload := strings.NewReader("{\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"Lead generation and qualification for enterprise sales\"\n }\n ],\n \"brandVoiceOId\": \"<string>\",\n \"modelType\": \"ECHO\",\n \"includeOriginal\": false\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/apply")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"Lead generation and qualification for enterprise sales\"\n }\n ],\n \"brandVoiceOId\": \"<string>\",\n \"modelType\": \"ECHO\",\n \"includeOriginal\": false\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"Lead generation and qualification for enterprise sales\"\n }\n ],\n \"brandVoiceOId\": \"<string>\",\n \"modelType\": \"ECHO\",\n \"includeOriginal\": false\n}"

response = http.request(request)
puts response.read_body
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "originalSource": {
        "type": "<string>",
        "value": "<string>"
      },
      "reasoning": "<string>",
      "transformedContent": "<string>",
      "originalContent": "<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
sources
object[]
required

Source materials to apply brand voice to

brandVoiceOId
string

Brand Voice OId to apply. If not provided, uses workspace default.

modelType
default:ECHO

Model quality tier. NOTE=5 credits, PULSE=10 credits, ECHO=20 credits, HARMONY=30 credits per source

Available options:
NOTE,
PULSE,
ECHO,
HARMONY,
CHORUS,
SYMPHONY
Example:

"ECHO"

includeOriginal
boolean
default:false

Include the original expanded content in the response. Defaults to false.

Example:

false

Response

Transformed sources with brand voice applied

_metadata
object
required
data
object[]
required