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>"
}
}Get Brand Voice by OId
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>"
}
}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.
Brand Voice OId
Brand Voice data
Show child attributes
Brand Voice OId
Creation date
Updated date
Brand Voice name
Deleted date
Show child attributes
Whether this is the default brand voice for the workspace
User data
Show child attributes
Workspace data
Show child attributes