Imports
Base URL: https://app.neuroflash.com/api/brand-voice-service
Auto-generate brand voice profiles from text, URLs, or uploaded files.
Import responses are draft previews — not saved entities
The import endpoints analyse your source material and return a proposed brand voice profile.
Nothing is saved to your workspace. The response contains no id and cannot be
retrieved later.
To persist the result, pass the extracted attributes to
POST /brand-voices in a follow-up call.
See the Brand Voice Pipeline guide for the complete workflow.
Creates a file import that converts the content into a brand voice
POST
/v1/workspaces/{workspaceId}/brand-voice-file-importsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | Workspace ID (uuid4) |
Request Body
FieldTypeRequiredDescription
audienceModelIdstringYescountrystringYesfileContentstringYesfilenamestringYeslanguagestringYesmimeTypestringYesResponse
FieldTypeDescription
brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringbrandVoiceobject
abbreviationRulesstringactivebooleanactiveVoicebooleanadvancedRulesarray<string>brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringcontentExamplesarray<object>
contentstringsourcestringurlstringcountrystringcreationSourceDocumentIDstringcreationSourceTextstringcreationSourceTypestringcreationSourceURLstringcurrencyFormatstringdateFormatstringdescriptionstringdontsstringemojiUsagestringgenderingstringgeneralToneobjectglossariesarray<object>
extendedstringshortcutstringheadlinePunctuationarray<string>hyphenationRulesarray<string>industryJargonstringlanguagestringnamestringnumberFormatstringpersonalbooleanperspectivearray<string>phoneNumberFormatstringthumbnailBase64stringbase64 encoded imagetimeFormatstringuseControversialEmojisbooleanuseHeaderPunctuationbooleanuseHyphensbooleanvocabularyarray<string>Example
- cURL
- Python
- Node.js
- Go
curl -X POST "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voice-file-imports" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"audienceModelId": "string",
"country": "string",
"fileContent": "string",
"filename": "string",
"language": "string",
"mimeType": "string"
}'
import requests
response = requests.post(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voice-file-imports",
headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
json={
"audienceModelId": "string",
"country": "string",
"fileContent": "string",
"filename": "string",
"language": "string",
"mimeType": "string"
},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voice-file-imports`,
{
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"audienceModelId": "string",
"country": "string",
"fileContent": "string",
"filename": "string",
"language": "string",
"mimeType": "string"
}),
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{
"audienceModelId": "string",
"country": "string",
"fileContent": "string",
"filename": "string",
"language": "string",
"mimeType": "string",
})
req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voice-file-imports", 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()
Response:
{
"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"
},
"brandVoice": {
"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"
},
"contentExamples": [
{
"content": "instagram post content",
"source": "instagram",
"url": "https://instagram.com/test"
}
],
"country": "us",
"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"
],
"industryJargon": "no_jargon",
"language": "en",
"name": "My Brand Voice",
"numberFormat": "EN",
"personal": false,
"perspective": [
"first_person_singular"
],
"phoneNumberFormat": "international_e164",
"thumbnailBase64": "string",
"timeFormat": "24h",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": [
"ChatFlash",
"image generation"
]
}
}
Creates a text import that converts it into a brand voice
POST
/v1/workspaces/{workspaceId}/brand-voice-text-importsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | Workspace ID (uuid4) |
Request Body
FieldTypeRequiredDescription
audienceModelIdstringYescountrystringYeslanguagestringYestextstringYesResponse
FieldTypeDescription
brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringbrandVoiceobject
abbreviationRulesstringactivebooleanactiveVoicebooleanadvancedRulesarray<string>brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringcontentExamplesarray<object>
contentstringsourcestringurlstringcountrystringcreationSourceDocumentIDstringcreationSourceTextstringcreationSourceTypestringcreationSourceURLstringcurrencyFormatstringdateFormatstringdescriptionstringdontsstringemojiUsagestringgenderingstringgeneralToneobjectglossariesarray<object>
extendedstringshortcutstringheadlinePunctuationarray<string>hyphenationRulesarray<string>industryJargonstringlanguagestringnamestringnumberFormatstringpersonalbooleanperspectivearray<string>phoneNumberFormatstringthumbnailBase64stringbase64 encoded imagetimeFormatstringuseControversialEmojisbooleanuseHeaderPunctuationbooleanuseHyphensbooleanvocabularyarray<string>Example
- cURL
- Python
- Node.js
- Go
curl -X POST "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voice-text-imports" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"audienceModelId": "string",
"country": "string",
"language": "string",
"text": "string"
}'
import requests
response = requests.post(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voice-text-imports",
headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
json={
"audienceModelId": "string",
"country": "string",
"language": "string",
"text": "string"
},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voice-text-imports`,
{
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"audienceModelId": "string",
"country": "string",
"language": "string",
"text": "string"
}),
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{
"audienceModelId": "string",
"country": "string",
"language": "string",
"text": "string",
})
req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voice-text-imports", 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()
Response:
{
"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"
},
"brandVoice": {
"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"
},
"contentExamples": [
{
"content": "instagram post content",
"source": "instagram",
"url": "https://instagram.com/test"
}
],
"country": "us",
"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"
],
"industryJargon": "no_jargon",
"language": "en",
"name": "My Brand Voice",
"numberFormat": "EN",
"personal": false,
"perspective": [
"first_person_singular"
],
"phoneNumberFormat": "international_e164",
"thumbnailBase64": "string",
"timeFormat": "24h",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": [
"ChatFlash",
"image generation"
]
}
}
Creates an UrlImport that parses the content of the given page and converts it into a brand voice
POST
/v1/workspaces/{workspaceId}/brand-voice-url-importsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | Workspace ID (uuid4) |
Request Body
FieldTypeRequiredDescription
audienceModelIdstringYescountrystringYeslanguagestringYesurlstringYesResponse
FieldTypeDescription
brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringbrandVoiceobject
abbreviationRulesstringactivebooleanactiveVoicebooleanadvancedRulesarray<string>brandobject
addressstringemailstringfacebookLinkstringinstagramLinkstringlinkedinLinkstringnamestringphonesarray<string>valuesarray<string>websitestringcontentExamplesarray<object>
contentstringsourcestringurlstringcountrystringcreationSourceDocumentIDstringcreationSourceTextstringcreationSourceTypestringcreationSourceURLstringcurrencyFormatstringdateFormatstringdescriptionstringdontsstringemojiUsagestringgenderingstringgeneralToneobjectglossariesarray<object>
extendedstringshortcutstringheadlinePunctuationarray<string>hyphenationRulesarray<string>industryJargonstringlanguagestringnamestringnumberFormatstringpersonalbooleanperspectivearray<string>phoneNumberFormatstringthumbnailBase64stringbase64 encoded imagetimeFormatstringuseControversialEmojisbooleanuseHeaderPunctuationbooleanuseHyphensbooleanvocabularyarray<string>Example
- cURL
- Python
- Node.js
- Go
curl -X POST "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voice-url-imports" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"audienceModelId": "538b1efc6f88ad88feebf7acd8c618facb54fe82",
"country": "string",
"language": "string",
"url": "string"
}'
import requests
response = requests.post(
f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brand-voice-url-imports",
headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
json={
"audienceModelId": "538b1efc6f88ad88feebf7acd8c618facb54fe82",
"country": "string",
"language": "string",
"url": "string"
},
).json()
const response = await fetch(
`https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brand-voice-url-imports`,
{
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"audienceModelId": "538b1efc6f88ad88feebf7acd8c618facb54fe82",
"country": "string",
"language": "string",
"url": "string"
}),
}
).then((r) => r.json());
body, _ := json.Marshal(map[string]any{
"audienceModelId": "538b1efc6f88ad88feebf7acd8c618facb54fe82",
"country": "string",
"language": "string",
"url": "string",
})
req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brand-voice-url-imports", 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()
Response:
{
"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"
},
"brandVoice": {
"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"
},
"contentExamples": [
{
"content": "instagram post content",
"source": "instagram",
"url": "https://instagram.com/test"
}
],
"country": "us",
"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"
],
"industryJargon": "no_jargon",
"language": "en",
"name": "My Brand Voice",
"numberFormat": "EN",
"personal": false,
"perspective": [
"first_person_singular"
],
"phoneNumberFormat": "international_e164",
"thumbnailBase64": "string",
"timeFormat": "24h",
"useControversialEmojis": false,
"useHeaderPunctuation": false,
"useHyphens": false,
"vocabulary": [
"ChatFlash",
"image generation"
]
}
}