Brand Voices
Basis-URL: https://app.neuroflash.com/api/brand-voice-service
Erstellen, verwalten und wenden Sie Markenstimmen für konsistente Inhaltsgenerierung an.
Neue Markensprache erstellen
/v1/workspaces/{workspaceId}/brand-voicesNeue Markensprache für den angegebenen Workspace erstellen.
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
Anfrage-Body
abbreviationRulesstringJaactivebooleanJaactiveVoicebooleanJaadvancedRulesarray<string>JabrandobjectJa
addressstringJaemailstringJafacebookLinkstringJainstagramLinkstringJalinkedinLinkstringJanamestringJaphonesarray<string>Javaluesarray<string>JawebsitestringJacontentExamplesarray<object>Ja
contentstringJasourcestringJaurlstringJacountrystringJacreationSourceDocumentIDstringJacreationSourceTextstringJacreationSourceTypestringJacreationSourceURLstringJacurrencyFormatstringJadateFormatstringJadescriptionstringJadontsstringJaemojiUsagestringJagenderingstringJageneralToneobjectJaglossariesarray<object>Ja
extendedstringJashortcutstringJaheadlinePunctuationarray<string>JahyphenationRulesarray<string>JaindustryJargonstringJalanguagestringJanamestringJanumberFormatstringJapersonalbooleanJaperspectivearray<string>JaphoneNumberFormatstringJathumbnailBase64stringJaBase64-codiertes BildtimeFormatstringJauseControversialEmojisbooleanJauseHeaderPunctuationbooleanJauseHyphensbooleanJavocabularyarray<string>JaAntwort
_embeddedobject
brandobject
addressstringcreatedAtstringcreatedByUserIdstringemailstringfacebookLinkstringidstringinstagramLinkstringlegacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdenlinkedinLinkstringnamestringownerLegacyCustomerIdintegerphonesarray<string>updatedAtstringvaluesarray<string>websitestringpermissionsobject
canDeletebooleancanDuplicatebooleancanUpdatebooleancanViewbooleanabbreviationRulesstringactivebooleanactiveVoicebooleanadvancedRulesarray<string>brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringcompletenessRatingintegercontentExamplesarray<object>
contentstringsourcestringurlstringcontradictionMessagestringcountrystringcreatedAtstringcreatedByUserIdstringcreationSourceDocumentIDstringcreationSourceTextstringcreationSourceTypestringcreationSourceURLstringcurrencyFormatstringdateFormatstringdescriptionstringdontsstringemojiUsagestringgenderingstringgeneralToneobjectglossariesarray<object>
extendedstringshortcutstringheadlinePunctuationarray<string>hyphenationRulesarray<string>idstringimportedFromChatPersonalityIdintegerindustryJargonstringisContradictorybooleanlanguagestringlegacybooleanWährend dieses Flag wahr ist, kann die Markenstimme noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdennamestringnumberFormatstringownerLegacyCustomerIDintegerpersonalbooleanperspectivearray<string>phoneNumberFormatstringthumbnailBase64stringBase64-codiertes BildthumbnailUrlstringtimeFormatstringupdatedAtstringuseControversialEmojisbooleanuseHeaderPunctuationbooleanuseHyphensbooleanvocabularyarray<string>workspaceIdstringBeispiel
- cURL
- Python
- Node.js
- Go
curl -X POST "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"abbreviationRules": "string",
"active": false,
"activeVoice": false,
"advancedRules": [],
"brand": {},
"contentExamples": [],
"country": "string",
"creationSourceDocumentID": "string",
"creationSourceText": "string",
"creationSourceType": "string",
"creationSourceURL": "string",
"currencyFormat": "string",
"dateFormat": "string",
"description": "string",
"donts": "string",
"emojiUsage": "string",
"gendering": "string",
"generalTone": {},
"glossaries": [],
"headlinePunctuation": [],
"hyphenationRules": [],
"industryJargon": "string",
"language": "string",
"name": "string",
"numberFormat": "string",
"personal": false,
"perspective": [],
"phoneNumberFormat": "string",
"thumbnailBase64": "string",
"timeFormat": "string",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": []
}'
import requests
response = requests.post(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices",
headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
json={
"abbreviationRules": "string",
"active": False,
"activeVoice": False,
"advancedRules": [],
"brand": {},
"contentExamples": [],
"country": "string",
"creationSourceDocumentID": "string",
"creationSourceText": "string",
"creationSourceType": "string",
"creationSourceURL": "string",
"currencyFormat": "string",
"dateFormat": "string",
"description": "string",
"donts": "string",
"emojiUsage": "string",
"gendering": "string",
"generalTone": {},
"glossaries": [],
"headlinePunctuation": [],
"hyphenationRules": [],
"industryJargon": "string",
"language": "string",
"name": "string",
"numberFormat": "string",
"personal": False,
"perspective": [],
"phoneNumberFormat": "string",
"thumbnailBase64": "string",
"timeFormat": "string",
"useControversialEmojis": False,
"useHeaderPunctuation": False,
"useHyphens": False,
"vocabulary": []
},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices`,
{
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"abbreviationRules": "string",
"active": false,
"activeVoice": false,
"advancedRules": [],
"brand": {},
"contentExamples": [],
"country": "string",
"creationSourceDocumentID": "string",
"creationSourceText": "string",
"creationSourceType": "string",
"creationSourceURL": "string",
"currencyFormat": "string",
"dateFormat": "string",
"description": "string",
"donts": "string",
"emojiUsage": "string",
"gendering": "string",
"generalTone": {},
"glossaries": [],
"headlinePunctuation": [],
"hyphenationRules": [],
"industryJargon": "string",
"language": "string",
"name": "string",
"numberFormat": "string",
"personal": false,
"perspective": [],
"phoneNumberFormat": "string",
"thumbnailBase64": "string",
"timeFormat": "string",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": []
}),
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{
"abbreviationRules": "string",
"active": false,
"activeVoice": false,
"advancedRules": []any{},
"brand": map[string]any{},
"contentExamples": []any{},
"country": "string",
"creationSourceDocumentID": "string",
"creationSourceText": "string",
"creationSourceType": "string",
"creationSourceURL": "string",
"currencyFormat": "string",
"dateFormat": "string",
"description": "string",
"donts": "string",
"emojiUsage": "string",
"gendering": "string",
"generalTone": map[string]any{},
"glossaries": []any{},
"headlinePunctuation": []any{},
"hyphenationRules": []any{},
"industryJargon": "string",
"language": "string",
"name": "string",
"numberFormat": "string",
"personal": false,
"perspective": []any{},
"phoneNumberFormat": "string",
"thumbnailBase64": "string",
"timeFormat": "string",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": []any{},
})
req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
Antwort:
{
"_embedded": {
"brand": {
"address": "Germany, Berlin, ...",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"instagramLink": "https://instagram.com/test",
"legacy": false,
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"ownerLegacyCustomerId": 32,
"phones": [
"+00000000",
"+11111111"
],
"updatedAt": "2025-01-14T16:20:59Z",
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"abbreviationRules": "use_freely",
"active": false,
"activeVoice": false,
"advancedRules": [
"string"
],
"brand": {
"address": "Germany, Berlin, ...",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"instagramLink": "https://instagram.com/test",
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"phones": [
"+00000000",
"+11111111"
],
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"completenessRating": 80,
"contentExamples": [
{
"content": "instagram post content",
"source": "instagram",
"url": "https://instagram.com/test"
}
],
"contradictionMessage": "Some contradiction message",
"country": "us",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"creationSourceDocumentID": "string",
"creationSourceText": "very interesting text that was used to import this brand voice",
"creationSourceType": "manual",
"creationSourceURL": "https://test.com",
"currencyFormat": "number_space_symbol",
"dateFormat": "EN",
"description": "Description of Brand Voice",
"donts": "string",
"emojiUsage": "no_emojis",
"gendering": "gender_neutral",
"generalTone": {},
"glossaries": [
{
"extended": "For your information",
"shortcut": "FYI"
}
],
"headlinePunctuation": [
"title_case"
],
"hyphenationRules": [
"allow_hyphenation_brand_name"
],
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"importedFromChatPersonalityId": 0,
"industryJargon": "no_jargon",
"isContradictory": true,
"language": "en",
"legacy": false,
"name": "My Brand Voice",
"numberFormat": "EN",
"ownerLegacyCustomerID": 123,
"personal": false,
"perspective": [
"first_person_singular"
],
"phoneNumberFormat": "international_e164",
"thumbnailBase64": "string",
"thumbnailUrl": "https://storage.googleapis.com/test/test.png",
"timeFormat": "24h",
"updatedAt": "2025-01-14T16:20:59Z",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": [
"ChatFlash",
"image generation"
],
"workspaceId": "27b01216-dc39-4cf4-9681-18443a6ea78e"
}
Legacy-Markensprache aktualisieren
/v1/workspaces/{workspaceId}/brand-voices/{brandVoiceId}/upgradeKonvertiert eine Legacy-Markensprache in das neue Format unter Verwendung des Quelltexts der Erstellung
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
brandVoiceId | string | Ja | Markensprachen-ID zum Aktualisieren |
Anfrage-Body
audienceModelIdstringJaBeispiel
- cURL
- Python
- Node.js
- Go
curl -X POST "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/upgrade" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"audienceModelId": "string"
}'
import requests
response = requests.post(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/upgrade",
headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
json={
"audienceModelId": "string"
},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices/${brandVoiceId}/upgrade`,
{
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"audienceModelId": "string"
}),
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{
"audienceModelId": "string",
})
req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices/"+brandVoiceID+"/upgrade", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
Konvertiert eine Markensprache in das von der Datenwissenschaft benötigte Format
/v1/workspaces/{workspaceId}/brand-voices/{brandVoiceId}/ds-promptDS-formatierte Markensprache nach ID für den angegebenen Workspace zurückgeben.
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
brandVoiceId | string | Ja | Markensprachen-ID |
Antwort
countrystringidstringimportedFromChatPersonalityIdintegerlanguagestringlegacybooleannamestringnewDefinitionobject
abbreviationsobject
optionsobjectselected_optionstringadditional_rulesobjectbrand_informationobject
brand_info_valuesarray<string>brand_namestringcontact_detailsobject
addressstringemailstringphonesstringsocial_media_linksarray<string>websitestringbrand_voiceobject
general_toneobjectlanguage_preferencesobject
activeVsPassiveobject
optionsobjectselected_optionstringcontentLocalestringheadlinePunctuationobject
optionsobjectselected_optionsarray<string>hyphenationRulesobject
optionsobjectselected_optionsarray<string>industry_jargonobject
optionsobjectselected_optionstringperspective_and_pronoun_usageobject
optionsobjectselected_optionsarray<string>vocabularyarray<string>voice_descriptionstringemojiUsageobject
additional_restrictionsobject
no_aggressive_or_controverse_emojisbooleanoptionsobjectselected_optionstringgenderingobject
optionsobjectselected_optionstringglossaryobjectsettingsobject
currencyFormatobject
optionsobjectselected_optionstringdateFormatobject
optionsobjectselected_optionstringnumberFormatobject
optionsobjectselected_optionstringphoneNumberFormatobject
optionsobjectselected_optionstringtimeFormatobject
optionsobjectselected_optionstringoldDefinitionstringBeispiel
- cURL
- Python
- Node.js
- Go
curl -X POST "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/ds-prompt" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
import requests
response = requests.post(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/ds-prompt",
headers={"Authorization": f"Bearer {token}"},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices/${brandVoiceId}/ds-prompt`,
{
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{})
req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices/"+brandVoiceID+"/ds-prompt", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
Antwort:
{
"country": "string",
"id": "string",
"importedFromChatPersonalityId": 0,
"language": "string",
"legacy": false,
"name": "string",
"newDefinition": {
"abbreviations": {
"options": {},
"selected_option": "string"
},
"additional_rules": {},
"brand_information": {
"brand_info_values": [
"string"
],
"brand_name": "string",
"contact_details": {
"address": "string",
"email": "string",
"phones": "string",
"social_media_links": [
"..."
]
},
"website": "string"
},
"brand_voice": {
"general_tone": {},
"language_preferences": {
"activeVsPassive": {
"options": "...",
"selected_option": "..."
},
"contentLocale": "string",
"headlinePunctuation": {
"options": "...",
"selected_options": "..."
},
"hyphenationRules": {
"options": "...",
"selected_options": "..."
},
"industry_jargon": {
"options": "...",
"selected_option": "..."
},
"perspective_and_pronoun_usage": {
"options": "...",
"selected_options": "..."
},
"vocabulary": [
"..."
]
},
"voice_description": "string"
},
"emojiUsage": {
"additional_restrictions": {
"no_aggressive_or_controverse_emojis": false
},
"options": {},
"selected_option": "string"
},
"gendering": {
"options": {},
"selected_option": "string"
},
"glossary": {},
"settings": {
"currencyFormat": {
"options": {},
"selected_option": "string"
},
"dateFormat": {
"options": {},
"selected_option": "string"
},
"numberFormat": {
"options": {},
"selected_option": "string"
},
"phoneNumberFormat": {
"options": {},
"selected_option": "string"
},
"timeFormat": {
"options": {},
"selected_option": "string"
}
}
},
"oldDefinition": "string"
}
Markensprache duplizieren
/v1/workspaces/{workspaceId}/brand-voices/{brandVoiceId}/duplicateNeue Markensprache für den angegebenen Workspace duplizieren.
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
brandVoiceId | string | Ja | Markensprachen-ID zum Duplizieren |
Anfrage-Body
newNamestringNeinAntwort
_embeddedobject
brandobject
addressstringcreatedAtstringcreatedByUserIdstringemailstringfacebookLinkstringidstringinstagramLinkstringlegacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdenlinkedinLinkstringnamestringownerLegacyCustomerIdintegerphonesarray<string>updatedAtstringvaluesarray<string>websitestringpermissionsobject
canDeletebooleancanDuplicatebooleancanUpdatebooleancanViewbooleanabbreviationRulesstringactivebooleanactiveVoicebooleanadvancedRulesarray<string>brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringcompletenessRatingintegercontentExamplesarray<object>
contentstringsourcestringurlstringcontradictionMessagestringcountrystringcreatedAtstringcreatedByUserIdstringcreationSourceDocumentIDstringcreationSourceTextstringcreationSourceTypestringcreationSourceURLstringcurrencyFormatstringdateFormatstringdescriptionstringdontsstringemojiUsagestringgenderingstringgeneralToneobjectglossariesarray<object>
extendedstringshortcutstringheadlinePunctuationarray<string>hyphenationRulesarray<string>idstringimportedFromChatPersonalityIdintegerindustryJargonstringisContradictorybooleanlanguagestringlegacybooleanWährend dieses Flag wahr ist, kann die Markenstimme noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdennamestringnumberFormatstringownerLegacyCustomerIDintegerpersonalbooleanperspectivearray<string>phoneNumberFormatstringthumbnailBase64stringBase64-codiertes BildthumbnailUrlstringtimeFormatstringupdatedAtstringuseControversialEmojisbooleanuseHeaderPunctuationbooleanuseHyphensbooleanvocabularyarray<string>workspaceIdstringBeispiel
- cURL
- Python
- Node.js
- Go
curl -X POST "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/duplicate" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"newName": "string"
}'
import requests
response = requests.post(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/duplicate",
headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
json={
"newName": "string"
},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices/${brandVoiceId}/duplicate`,
{
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"newName": "string"
}),
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{
"newName": "string",
})
req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices/"+brandVoiceID+"/duplicate", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
Antwort:
{
"_embedded": {
"brand": {
"address": "Germany, Berlin, ...",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"instagramLink": "https://instagram.com/test",
"legacy": false,
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"ownerLegacyCustomerId": 32,
"phones": [
"+00000000",
"+11111111"
],
"updatedAt": "2025-01-14T16:20:59Z",
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"abbreviationRules": "use_freely",
"active": false,
"activeVoice": false,
"advancedRules": [
"string"
],
"brand": {
"address": "Germany, Berlin, ...",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"instagramLink": "https://instagram.com/test",
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"phones": [
"+00000000",
"+11111111"
],
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"completenessRating": 80,
"contentExamples": [
{
"content": "instagram post content",
"source": "instagram",
"url": "https://instagram.com/test"
}
],
"contradictionMessage": "Some contradiction message",
"country": "us",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"creationSourceDocumentID": "string",
"creationSourceText": "very interesting text that was used to import this brand voice",
"creationSourceType": "manual",
"creationSourceURL": "https://test.com",
"currencyFormat": "number_space_symbol",
"dateFormat": "EN",
"description": "Description of Brand Voice",
"donts": "string",
"emojiUsage": "no_emojis",
"gendering": "gender_neutral",
"generalTone": {},
"glossaries": [
{
"extended": "For your information",
"shortcut": "FYI"
}
],
"headlinePunctuation": [
"title_case"
],
"hyphenationRules": [
"allow_hyphenation_brand_name"
],
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"importedFromChatPersonalityId": 0,
"industryJargon": "no_jargon",
"isContradictory": true,
"language": "en",
"legacy": false,
"name": "My Brand Voice",
"numberFormat": "EN",
"ownerLegacyCustomerID": 123,
"personal": false,
"perspective": [
"first_person_singular"
],
"phoneNumberFormat": "international_e164",
"thumbnailBase64": "string",
"thumbnailUrl": "https://storage.googleapis.com/test/test.png",
"timeFormat": "24h",
"updatedAt": "2025-01-14T16:20:59Z",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": [
"ChatFlash",
"image generation"
],
"workspaceId": "27b01216-dc39-4cf4-9681-18443a6ea78e"
}
Berechnet Markensprachen-Widerspruch
/v1/workspaces/{workspaceId}/brand-voices/{brandVoiceId}/calculate-contradictionBerechnet Markensprachen-Widerspruch und speichert das Ergebnis.
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
brandVoiceId | string | Ja | Markensprachen-ID |
Anfrage-Body
audienceModelIdstringJaAntwort
_embeddedobject
brandobject
addressstringcreatedAtstringcreatedByUserIdstringemailstringfacebookLinkstringidstringinstagramLinkstringlegacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdenlinkedinLinkstringnamestringownerLegacyCustomerIdintegerphonesarray<string>updatedAtstringvaluesarray<string>websitestringpermissionsobject
canDeletebooleancanDuplicatebooleancanUpdatebooleancanViewbooleanabbreviationRulesstringactivebooleanactiveVoicebooleanadvancedRulesarray<string>brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringcompletenessRatingintegercontentExamplesarray<object>
contentstringsourcestringurlstringcontradictionMessagestringcountrystringcreatedAtstringcreatedByUserIdstringcreationSourceDocumentIDstringcreationSourceTextstringcreationSourceTypestringcreationSourceURLstringcurrencyFormatstringdateFormatstringdescriptionstringdontsstringemojiUsagestringgenderingstringgeneralToneobjectglossariesarray<object>
extendedstringshortcutstringheadlinePunctuationarray<string>hyphenationRulesarray<string>idstringimportedFromChatPersonalityIdintegerindustryJargonstringisContradictorybooleanlanguagestringlegacybooleanWährend dieses Flag wahr ist, kann die Markenstimme noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdennamestringnumberFormatstringownerLegacyCustomerIDintegerpersonalbooleanperspectivearray<string>phoneNumberFormatstringthumbnailBase64stringBase64-codiertes BildthumbnailUrlstringtimeFormatstringupdatedAtstringuseControversialEmojisbooleanuseHeaderPunctuationbooleanuseHyphensbooleanvocabularyarray<string>workspaceIdstringBeispiel
- cURL
- Python
- Node.js
- Go
curl -X POST "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/calculate-contradiction" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"audienceModelId": "string"
}'
import requests
response = requests.post(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/calculate-contradiction",
headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
json={
"audienceModelId": "string"
},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices/${brandVoiceId}/calculate-contradiction`,
{
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"audienceModelId": "string"
}),
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{
"audienceModelId": "string",
})
req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices/"+brandVoiceID+"/calculate-contradiction", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
Antwort:
{
"_embedded": {
"brand": {
"address": "Germany, Berlin, ...",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"instagramLink": "https://instagram.com/test",
"legacy": false,
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"ownerLegacyCustomerId": 32,
"phones": [
"+00000000",
"+11111111"
],
"updatedAt": "2025-01-14T16:20:59Z",
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"abbreviationRules": "use_freely",
"active": false,
"activeVoice": false,
"advancedRules": [
"string"
],
"brand": {
"address": "Germany, Berlin, ...",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"instagramLink": "https://instagram.com/test",
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"phones": [
"+00000000",
"+11111111"
],
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"completenessRating": 80,
"contentExamples": [
{
"content": "instagram post content",
"source": "instagram",
"url": "https://instagram.com/test"
}
],
"contradictionMessage": "Some contradiction message",
"country": "us",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"creationSourceDocumentID": "string",
"creationSourceText": "very interesting text that was used to import this brand voice",
"creationSourceType": "manual",
"creationSourceURL": "https://test.com",
"currencyFormat": "number_space_symbol",
"dateFormat": "EN",
"description": "Description of Brand Voice",
"donts": "string",
"emojiUsage": "no_emojis",
"gendering": "gender_neutral",
"generalTone": {},
"glossaries": [
{
"extended": "For your information",
"shortcut": "FYI"
}
],
"headlinePunctuation": [
"title_case"
],
"hyphenationRules": [
"allow_hyphenation_brand_name"
],
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"importedFromChatPersonalityId": 0,
"industryJargon": "no_jargon",
"isContradictory": true,
"language": "en",
"legacy": false,
"name": "My Brand Voice",
"numberFormat": "EN",
"ownerLegacyCustomerID": 123,
"personal": false,
"perspective": [
"first_person_singular"
],
"phoneNumberFormat": "international_e164",
"thumbnailBase64": "string",
"thumbnailUrl": "https://storage.googleapis.com/test/test.png",
"timeFormat": "24h",
"updatedAt": "2025-01-14T16:20:59Z",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": [
"ChatFlash",
"image generation"
],
"workspaceId": "27b01216-dc39-4cf4-9681-18443a6ea78e"
}
Markenstimmen auflisten
/v1/workspaces/{workspaceId}/brand-voicesRufen Sie eine paginierte Liste von Markenstimmen basierend auf Filterkriterien wie Name, Land, Sprache, Besitzer und Arbeitsbereich ab.
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
Abfrageparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
name | string | — | Nach Markenstimmname filtern |
search | string | — | Nach Markenstimmname, Markenname und URL filtern |
country | string | — | Nach Land filtern (ISO Alpha-2-Code) |
language | string | — | Nach Sprache filtern (ISO Alpha-2-Code) |
ownerLegacyCustomerId | integer | — | Nach Kunden-ID filtern |
importedFromChatPersonalityIds | string | — | Nach importierten Persönlichkeits-IDs filtern |
withRelations | boolean | true | Zugehörige Daten einschließen |
includeDefaultFirst | boolean | true | Standard-Markensprache zuerst einschließen |
sort | string | updated_at | Sortieren: leer, neueste, aktualisiert_am, Name |
order | string | ASC | Sortieren: ASC, DESC |
page | integer | 1 | Seite |
size | integer | 10 | Seitengröße (1-100) |
Antwort
dataarray<object>
_embeddedobject
brandobject
addressstringcreatedAtstringcreatedByUserIdstringemailstringfacebookLinkstringidstringinstagramLinkstringlegacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdenlinkedinLinkstringnamestringownerLegacyCustomerIdintegerphonesarray<string>updatedAtstringvaluesarray<string>websitestringpermissionsobject
canDeletebooleancanDuplicatebooleancanUpdatebooleancanViewbooleanabbreviationRulesstringactivebooleanactiveVoicebooleanadvancedRulesarray<string>brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringcompletenessRatingintegercontentExamplesarray<object>
contentstringsourcestringurlstringcontradictionMessagestringcountrystringcreatedAtstringcreatedByUserIdstringcreationSourceDocumentIDstringcreationSourceTextstringcreationSourceTypestringcreationSourceURLstringcurrencyFormatstringdateFormatstringdescriptionstringdontsstringemojiUsagestringgenderingstringgeneralToneobjectglossariesarray<object>
extendedstringshortcutstringheadlinePunctuationarray<string>hyphenationRulesarray<string>idstringimportedFromChatPersonalityIdintegerindustryJargonstringisContradictorybooleanlanguagestringlegacybooleanWährend dieses Flag wahr ist, kann die Markenstimme noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdennamestringnumberFormatstringownerLegacyCustomerIDintegerpersonalbooleanperspectivearray<string>phoneNumberFormatstringthumbnailBase64stringBase64-codiertes BildthumbnailUrlstringtimeFormatstringupdatedAtstringuseControversialEmojisbooleanuseHeaderPunctuationbooleanuseHyphensbooleanvocabularyarray<string>workspaceIdstringpageobject
currentPageintegersizeintegertotalElementsintegertotalPagesintegerBeispiel
- cURL
- Python
- Node.js
- Go
curl "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
import requests
response = requests.get(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices",
headers={"Authorization": f"Bearer {token}"},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices`,
{ headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());
req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices", nil)
req.Header.Set("Authorization", "Bearer "+token)
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
Antwort:
{
"data": [
{
"_embedded": {
"brand": {
"address": "...",
"createdAt": "...",
"createdByUserId": "...",
"email": "...",
"facebookLink": "...",
"id": "...",
"instagramLink": "...",
"legacy": "...",
"linkedinLink": "...",
"name": "...",
"ownerLegacyCustomerId": "...",
"phones": "...",
"updatedAt": "...",
"values": "...",
"website": "..."
},
"permissions": {
"canDelete": "...",
"canDuplicate": "...",
"canUpdate": "...",
"canView": "..."
}
},
"abbreviationRules": "use_freely",
"active": false,
"activeVoice": false,
"advancedRules": [
"string"
],
"brand": {
"address": "Germany, Berlin, ...",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"instagramLink": "https://instagram.com/test",
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"phones": [
"+00000000",
"+11111111"
],
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"completenessRating": 80,
"contentExamples": [
{
"content": "...",
"source": "...",
"url": "..."
}
],
"contradictionMessage": "Some contradiction message",
"country": "us",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"creationSourceDocumentID": "string",
"creationSourceText": "very interesting text that was used to import this brand voice",
"creationSourceType": "manual",
"creationSourceURL": "https://test.com",
"currencyFormat": "number_space_symbol",
"dateFormat": "EN",
"description": "Description of Brand Voice",
"donts": "string",
"emojiUsage": "no_emojis",
"gendering": "gender_neutral",
"generalTone": {},
"glossaries": [
{
"extended": "...",
"shortcut": "..."
}
],
"headlinePunctuation": [
"title_case"
],
"hyphenationRules": [
"allow_hyphenation_brand_name"
],
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"importedFromChatPersonalityId": 0,
"industryJargon": "no_jargon",
"isContradictory": true,
"language": "en",
"legacy": false,
"name": "My Brand Voice",
"numberFormat": "EN",
"ownerLegacyCustomerID": 123,
"personal": false,
"perspective": [
"first_person_singular"
],
"phoneNumberFormat": "international_e164",
"thumbnailBase64": "string",
"thumbnailUrl": "https://storage.googleapis.com/test/test.png",
"timeFormat": "24h",
"updatedAt": "2025-01-14T16:20:59Z",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": [
"ChatFlash",
"image generation"
],
"workspaceId": "27b01216-dc39-4cf4-9681-18443a6ea78e"
}
],
"page": {
"currentPage": 2,
"size": 10,
"totalElements": 35,
"totalPages": 4
}
}
Markensprache nach ID suchen
/v1/workspaces/{workspaceId}/brand-voices/{brandVoiceId}Details einer Markensprache nach ID für den angegebenen Workspace abrufen.
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
brandVoiceId | string | Ja | Markensprachen-ID |
Antwort
_embeddedobject
brandobject
addressstringcreatedAtstringcreatedByUserIdstringemailstringfacebookLinkstringidstringinstagramLinkstringlegacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdenlinkedinLinkstringnamestringownerLegacyCustomerIdintegerphonesarray<string>updatedAtstringvaluesarray<string>websitestringpermissionsobject
canDeletebooleancanDuplicatebooleancanUpdatebooleancanViewbooleanabbreviationRulesstringactivebooleanactiveVoicebooleanadvancedRulesarray<string>brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringcompletenessRatingintegercontentExamplesarray<object>
contentstringsourcestringurlstringcontradictionMessagestringcountrystringcreatedAtstringcreatedByUserIdstringcreationSourceDocumentIDstringcreationSourceTextstringcreationSourceTypestringcreationSourceURLstringcurrencyFormatstringdateFormatstringdescriptionstringdontsstringemojiUsagestringgenderingstringgeneralToneobjectglossariesarray<object>
extendedstringshortcutstringheadlinePunctuationarray<string>hyphenationRulesarray<string>idstringimportedFromChatPersonalityIdintegerindustryJargonstringisContradictorybooleanlanguagestringlegacybooleanWährend dieses Flag wahr ist, kann die Markenstimme noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdennamestringnumberFormatstringownerLegacyCustomerIDintegerpersonalbooleanperspectivearray<string>phoneNumberFormatstringthumbnailBase64stringBase64-codiertes BildthumbnailUrlstringtimeFormatstringupdatedAtstringuseControversialEmojisbooleanuseHeaderPunctuationbooleanuseHyphensbooleanvocabularyarray<string>workspaceIdstringBeispiel
- cURL
- Python
- Node.js
- Go
curl "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
import requests
response = requests.get(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}",
headers={"Authorization": f"Bearer {token}"},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices/${brandVoiceId}`,
{ headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());
req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices/"+brandVoiceID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
Antwort:
{
"_embedded": {
"brand": {
"address": "Germany, Berlin, ...",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"instagramLink": "https://instagram.com/test",
"legacy": false,
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"ownerLegacyCustomerId": 32,
"phones": [
"+00000000",
"+11111111"
],
"updatedAt": "2025-01-14T16:20:59Z",
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"abbreviationRules": "use_freely",
"active": false,
"activeVoice": false,
"advancedRules": [
"string"
],
"brand": {
"address": "Germany, Berlin, ...",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"instagramLink": "https://instagram.com/test",
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"phones": [
"+00000000",
"+11111111"
],
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"completenessRating": 80,
"contentExamples": [
{
"content": "instagram post content",
"source": "instagram",
"url": "https://instagram.com/test"
}
],
"contradictionMessage": "Some contradiction message",
"country": "us",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"creationSourceDocumentID": "string",
"creationSourceText": "very interesting text that was used to import this brand voice",
"creationSourceType": "manual",
"creationSourceURL": "https://test.com",
"currencyFormat": "number_space_symbol",
"dateFormat": "EN",
"description": "Description of Brand Voice",
"donts": "string",
"emojiUsage": "no_emojis",
"gendering": "gender_neutral",
"generalTone": {},
"glossaries": [
{
"extended": "For your information",
"shortcut": "FYI"
}
],
"headlinePunctuation": [
"title_case"
],
"hyphenationRules": [
"allow_hyphenation_brand_name"
],
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"importedFromChatPersonalityId": 0,
"industryJargon": "no_jargon",
"isContradictory": true,
"language": "en",
"legacy": false,
"name": "My Brand Voice",
"numberFormat": "EN",
"ownerLegacyCustomerID": 123,
"personal": false,
"perspective": [
"first_person_singular"
],
"phoneNumberFormat": "international_e164",
"thumbnailBase64": "string",
"thumbnailUrl": "https://storage.googleapis.com/test/test.png",
"timeFormat": "24h",
"updatedAt": "2025-01-14T16:20:59Z",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": [
"ChatFlash",
"image generation"
],
"workspaceId": "27b01216-dc39-4cf4-9681-18443a6ea78e"
}
Markensprache aktualisieren
/v1/workspaces/{workspaceId}/brand-voices/{brandVoiceId}Details einer Markensprache nach ID für den angegebenen Workspace aktualisieren.
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
brandVoiceId | string | Ja | Markensprachen-ID |
Anfrage-Body
abbreviationRulesstringJaactivebooleanJaactiveVoicebooleanJaadvancedRulesarray<string>JabrandobjectJa
addressstringJaemailstringJafacebookLinkstringJainstagramLinkstringJalinkedinLinkstringJanamestringJaphonesarray<string>Javaluesarray<string>JawebsitestringJacontentExamplesarray<object>Ja
contentstringJasourcestringJaurlstringJacountrystringJacurrencyFormatstringJadateFormatstringJadescriptionstringJadontsstringJaemojiUsagestringJagenderingstringJageneralToneobjectJaglossariesarray<object>Ja
extendedstringJashortcutstringJaheadlinePunctuationarray<string>JahyphenationRulesarray<string>JaindustryJargonstringJalanguagestringJanamestringJanumberFormatstringJapersonalbooleanJaperspectivearray<string>JaphoneNumberFormatstringJathumbnailBase64stringJaBase64-codiertes BildtimeFormatstringJauseControversialEmojisbooleanJauseHeaderPunctuationbooleanJauseHyphensbooleanJavocabularyarray<string>JaAntwort
_embeddedobject
brandobject
addressstringcreatedAtstringcreatedByUserIdstringemailstringfacebookLinkstringidstringinstagramLinkstringlegacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdenlinkedinLinkstringnamestringownerLegacyCustomerIdintegerphonesarray<string>updatedAtstringvaluesarray<string>websitestringpermissionsobject
canDeletebooleancanDuplicatebooleancanUpdatebooleancanViewbooleanabbreviationRulesstringactivebooleanactiveVoicebooleanadvancedRulesarray<string>brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringcompletenessRatingintegercontentExamplesarray<object>
contentstringsourcestringurlstringcontradictionMessagestringcountrystringcreatedAtstringcreatedByUserIdstringcreationSourceDocumentIDstringcreationSourceTextstringcreationSourceTypestringcreationSourceURLstringcurrencyFormatstringdateFormatstringdescriptionstringdontsstringemojiUsagestringgenderingstringgeneralToneobjectglossariesarray<object>
extendedstringshortcutstringheadlinePunctuationarray<string>hyphenationRulesarray<string>idstringimportedFromChatPersonalityIdintegerindustryJargonstringisContradictorybooleanlanguagestringlegacybooleanWährend dieses Flag wahr ist, kann die Markenstimme noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werdennamestringnumberFormatstringownerLegacyCustomerIDintegerpersonalbooleanperspectivearray<string>phoneNumberFormatstringthumbnailBase64stringBase64-codiertes BildthumbnailUrlstringtimeFormatstringupdatedAtstringuseControversialEmojisbooleanuseHeaderPunctuationbooleanuseHyphensbooleanvocabularyarray<string>workspaceIdstringBeispiel
- cURL
- Python
- Node.js
- Go
curl -X PUT "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"abbreviationRules": "string",
"active": false,
"activeVoice": false,
"advancedRules": [],
"brand": {},
"contentExamples": [],
"country": "string",
"currencyFormat": "string",
"dateFormat": "string",
"description": "string",
"donts": "string",
"emojiUsage": "string",
"gendering": "string",
"generalTone": {},
"glossaries": [],
"headlinePunctuation": [],
"hyphenationRules": [],
"industryJargon": "string",
"language": "string",
"name": "string",
"numberFormat": "string",
"personal": false,
"perspective": [],
"phoneNumberFormat": "string",
"thumbnailBase64": "string",
"timeFormat": "string",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": []
}'
import requests
response = requests.put(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}",
headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
json={
"abbreviationRules": "string",
"active": False,
"activeVoice": False,
"advancedRules": [],
"brand": {},
"contentExamples": [],
"country": "string",
"currencyFormat": "string",
"dateFormat": "string",
"description": "string",
"donts": "string",
"emojiUsage": "string",
"gendering": "string",
"generalTone": {},
"glossaries": [],
"headlinePunctuation": [],
"hyphenationRules": [],
"industryJargon": "string",
"language": "string",
"name": "string",
"numberFormat": "string",
"personal": False,
"perspective": [],
"phoneNumberFormat": "string",
"thumbnailBase64": "string",
"timeFormat": "string",
"useControversialEmojis": False,
"useHeaderPunctuation": False,
"useHyphens": False,
"vocabulary": []
},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices/${brandVoiceId}`,
{
method: "PUT",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"abbreviationRules": "string",
"active": false,
"activeVoice": false,
"advancedRules": [],
"brand": {},
"contentExamples": [],
"country": "string",
"currencyFormat": "string",
"dateFormat": "string",
"description": "string",
"donts": "string",
"emojiUsage": "string",
"gendering": "string",
"generalTone": {},
"glossaries": [],
"headlinePunctuation": [],
"hyphenationRules": [],
"industryJargon": "string",
"language": "string",
"name": "string",
"numberFormat": "string",
"personal": false,
"perspective": [],
"phoneNumberFormat": "string",
"thumbnailBase64": "string",
"timeFormat": "string",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": []
}),
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{
"abbreviationRules": "string",
"active": false,
"activeVoice": false,
"advancedRules": []any{},
"brand": map[string]any{},
"contentExamples": []any{},
"country": "string",
"currencyFormat": "string",
"dateFormat": "string",
"description": "string",
"donts": "string",
"emojiUsage": "string",
"gendering": "string",
"generalTone": map[string]any{},
"glossaries": []any{},
"headlinePunctuation": []any{},
"hyphenationRules": []any{},
"industryJargon": "string",
"language": "string",
"name": "string",
"numberFormat": "string",
"personal": false,
"perspective": []any{},
"phoneNumberFormat": "string",
"thumbnailBase64": "string",
"timeFormat": "string",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": []any{},
})
req, _ := http.NewRequest("PUT", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices/"+brandVoiceID+"", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
Antwort:
{
"_embedded": {
"brand": {
"address": "Germany, Berlin, ...",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"instagramLink": "https://instagram.com/test",
"legacy": false,
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"ownerLegacyCustomerId": 32,
"phones": [
"+00000000",
"+11111111"
],
"updatedAt": "2025-01-14T16:20:59Z",
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"abbreviationRules": "use_freely",
"active": false,
"activeVoice": false,
"advancedRules": [
"string"
],
"brand": {
"address": "Germany, Berlin, ...",
"email": "test@neuroflash.com",
"facebookLink": "https://facebook.com/test",
"instagramLink": "https://instagram.com/test",
"linkedinLink": "https://linkedin.com/test",
"name": "neuroflash",
"phones": [
"+00000000",
"+11111111"
],
"values": [
"proactivity",
"stability"
],
"website": "https://test.com"
},
"completenessRating": 80,
"contentExamples": [
{
"content": "instagram post content",
"source": "instagram",
"url": "https://instagram.com/test"
}
],
"contradictionMessage": "Some contradiction message",
"country": "us",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"creationSourceDocumentID": "string",
"creationSourceText": "very interesting text that was used to import this brand voice",
"creationSourceType": "manual",
"creationSourceURL": "https://test.com",
"currencyFormat": "number_space_symbol",
"dateFormat": "EN",
"description": "Description of Brand Voice",
"donts": "string",
"emojiUsage": "no_emojis",
"gendering": "gender_neutral",
"generalTone": {},
"glossaries": [
{
"extended": "For your information",
"shortcut": "FYI"
}
],
"headlinePunctuation": [
"title_case"
],
"hyphenationRules": [
"allow_hyphenation_brand_name"
],
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"importedFromChatPersonalityId": 0,
"industryJargon": "no_jargon",
"isContradictory": true,
"language": "en",
"legacy": false,
"name": "My Brand Voice",
"numberFormat": "EN",
"ownerLegacyCustomerID": 123,
"personal": false,
"perspective": [
"first_person_singular"
],
"phoneNumberFormat": "international_e164",
"thumbnailBase64": "string",
"thumbnailUrl": "https://storage.googleapis.com/test/test.png",
"timeFormat": "24h",
"updatedAt": "2025-01-14T16:20:59Z",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": [
"ChatFlash",
"image generation"
],
"workspaceId": "27b01216-dc39-4cf4-9681-18443a6ea78e"
}
Erstellt eine Verwendung einer Markensprache
/v1/workspaces/{workspaceId}/brand-voices/{brandVoiceId}/usageErstelle eine dokumentierte Verwendung einer Markensprache, die zur Bestimmung der zuletzt verwendeten Markensprache verwendet wird.
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
brandVoiceId | string | Ja | BrandVoice-ID (uuid4) |
Antwort
brandVoiceIdstringcreatedAtstringcreatedByUserIdstringidstringupdatedAtstringusageCountintegerworkspaceIdstringBeispiel
- cURL
- Python
- Node.js
- Go
curl -X PUT "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/usage" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
import requests
response = requests.put(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}/usage",
headers={"Authorization": f"Bearer {token}"},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices/${brandVoiceId}/usage`,
{
method: "PUT",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{})
req, _ := http.NewRequest("PUT", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices/"+brandVoiceID+"/usage", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
Antwort:
{
"brandVoiceId": "27b01216-dc39-4cf4-9681-18443a6ea78e",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"updatedAt": "2025-01-14T16:20:59Z",
"usageCount": 100,
"workspaceId": "27b01216-dc39-4cf4-9681-18443a6ea78e"
}
Markensprache löschen
/v1/workspaces/{workspaceId}/brand-voices/{brandVoiceId}Markensprache nach ID für den angegebenen Workspace löschen.
Pfadparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceId | string | Ja | Arbeitsbereich-ID (uuid4) |
brandVoiceId | string | Ja | Markensprachen-ID |
Beispiel
- cURL
- Python
- Node.js
- Go
curl -X DELETE "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
import requests
requests.delete(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voices/{brand_voice_id}",
headers={"Authorization": f"Bearer {token}"},
)
await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voices/${brandVoiceId}`,
{
method: "DELETE",
headers: { Authorization: `Bearer ${token}` },
}
);
req, _ := http.NewRequest("DELETE", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voices/"+brandVoiceID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()