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
}
'
{
  "_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>"
    }
  ]
}

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
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