Skip to main content

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

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID (uuid4)

Request Body

FieldTypeRequiredDescription
audienceModelIdstringYes
countrystringYes
fileContentstringYes
filenamestringYes
languagestringYes
mimeTypestringYes

Response

FieldTypeDescription
brandobject
addressstring
emailstring
facebookLinkstring
instagramLinkstring
linkedinLinkstring
namestring
phonesarray<string>
valuesarray<string>
websitestring
brandVoiceobject
abbreviationRulesstring
activeboolean
activeVoiceboolean
advancedRulesarray<string>
brandobject
addressstring
emailstring
facebookLinkstring
instagramLinkstring
linkedinLinkstring
namestring
phonesarray<string>
valuesarray<string>
websitestring
contentExamplesarray<object>
contentstring
sourcestring
urlstring
countrystring
creationSourceDocumentIDstring
creationSourceTextstring
creationSourceTypestring
creationSourceURLstring
currencyFormatstring
dateFormatstring
descriptionstring
dontsstring
emojiUsagestring
genderingstring
generalToneobject
glossariesarray<object>
extendedstring
shortcutstring
headlinePunctuationarray<string>
hyphenationRulesarray<string>
industryJargonstring
languagestring
namestring
numberFormatstring
personalboolean
perspectivearray<string>
phoneNumberFormatstring
thumbnailBase64stringbase64 encoded image
timeFormatstring
useControversialEmojisboolean
useHeaderPunctuationboolean
useHyphensboolean
vocabularyarray<string>

Example

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"
}'

Note: This response is a draft. No brand voice has been created yet. Use the brandVoice fields as input to POST /brand-voices to save it.

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

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID (uuid4)

Request Body

FieldTypeRequiredDescription
audienceModelIdstringYes
countrystringYes
languagestringYes
textstringYes

Response

FieldTypeDescription
brandobject
addressstring
emailstring
facebookLinkstring
instagramLinkstring
linkedinLinkstring
namestring
phonesarray<string>
valuesarray<string>
websitestring
brandVoiceobject
abbreviationRulesstring
activeboolean
activeVoiceboolean
advancedRulesarray<string>
brandobject
addressstring
emailstring
facebookLinkstring
instagramLinkstring
linkedinLinkstring
namestring
phonesarray<string>
valuesarray<string>
websitestring
contentExamplesarray<object>
contentstring
sourcestring
urlstring
countrystring
creationSourceDocumentIDstring
creationSourceTextstring
creationSourceTypestring
creationSourceURLstring
currencyFormatstring
dateFormatstring
descriptionstring
dontsstring
emojiUsagestring
genderingstring
generalToneobject
glossariesarray<object>
extendedstring
shortcutstring
headlinePunctuationarray<string>
hyphenationRulesarray<string>
industryJargonstring
languagestring
namestring
numberFormatstring
personalboolean
perspectivearray<string>
phoneNumberFormatstring
thumbnailBase64stringbase64 encoded image
timeFormatstring
useControversialEmojisboolean
useHeaderPunctuationboolean
useHyphensboolean
vocabularyarray<string>

Example

These endpoints are asynchronous

Brand voice import involves AI analysis and may take 10–30 seconds. Plan your integration accordingly and consider polling or retry logic if you need the result immediately.

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": "538b1efc6f88ad88feebf7acd8c618facb54fe82",
"country": "us",
"language": "en",
"text": "neuroflash is Europe's leading AI content platform, helping marketing teams create on-brand content faster with a clear, confident, and human voice."
}'

Note: This response is a draft. No brand voice has been created yet. Use the brandVoice fields as input to POST /brand-voices to save it.

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

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID (uuid4)

Request Body

FieldTypeRequiredDescription
audienceModelIdstringYes
countrystringYes
languagestringYes
urlstringYes

Response

FieldTypeDescription
brandobject
addressstring
emailstring
facebookLinkstring
instagramLinkstring
linkedinLinkstring
namestring
phonesarray<string>
valuesarray<string>
websitestring
brandVoiceobject
abbreviationRulesstring
activeboolean
activeVoiceboolean
advancedRulesarray<string>
brandobject
addressstring
emailstring
facebookLinkstring
instagramLinkstring
linkedinLinkstring
namestring
phonesarray<string>
valuesarray<string>
websitestring
contentExamplesarray<object>
contentstring
sourcestring
urlstring
countrystring
creationSourceDocumentIDstring
creationSourceTextstring
creationSourceTypestring
creationSourceURLstring
currencyFormatstring
dateFormatstring
descriptionstring
dontsstring
emojiUsagestring
genderingstring
generalToneobject
glossariesarray<object>
extendedstring
shortcutstring
headlinePunctuationarray<string>
hyphenationRulesarray<string>
industryJargonstring
languagestring
namestring
numberFormatstring
personalboolean
perspectivearray<string>
phoneNumberFormatstring
thumbnailBase64stringbase64 encoded image
timeFormatstring
useControversialEmojisboolean
useHeaderPunctuationboolean
useHyphensboolean
vocabularyarray<string>

Example

These endpoints are asynchronous

Brand voice import involves AI analysis and may take 10–30 seconds. Plan your integration accordingly and consider polling or retry logic if you need the result immediately.

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": "https://your-brand.com"
}'

Note: This response is a draft. No brand voice has been created yet. Use the brandVoice fields as input to POST /brand-voices to save it.

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"
]
}
}

Persisting an Import Draft

Import responses are not saved automatically. Use the extracted brandVoice attributes to create a brand voice in a follow-up call:

# Step 1: Import from URL — get the draft
DRAFT=$(curl -s -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": "us",
"language": "en",
"url": "https://your-brand.com"
}')

# Step 2: Create brand voice with extracted name and description
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 "{
\"name\": $(echo $DRAFT | jq '.brandVoice.name'),
\"description\": $(echo $DRAFT | jq '.brandVoice.description'),
\"language\": $(echo $DRAFT | jq '.brandVoice.language'),
\"country\": $(echo $DRAFT | jq '.brandVoice.country'),
\"creationSourceType\": \"url\",
\"creationSourceURL\": \"https://your-brand.com\",
\"brand\": { \"name\": $(echo $DRAFT | jq '.brand.name'), \"values\": [], \"phones\": [] }
}"