Importe

Basis-URL: https://app.neuroflash.com/api/brand-voice-service

Generieren Sie automatisch Brand-Voice-Profile aus Text, URLs oder hochgeladenen Dateien.

Importantworten sind Entwurfvorschau — keine gespeicherten Entitäten

Die Import-Endpunkte analysieren Ihr Quellmaterial und geben ein vorgeschlagenes Brand-Voice-Profil zurück. Nichts wird in Ihrem Workspace gespeichert. Die Antwort enthält keine id und kann später nicht abgerufen werden.

Um das Ergebnis zu speichern, übergeben Sie die extrahierten Attribute an POST /brand-voices in einem nachfolgenden Aufruf. Siehe die Brand-Voice-Pipeline-Anleitung für den vollständigen Workflow.

Erstellt einen Dateiimport, der den Inhalt in eine Brand Voice konvertiert

POST/v1/workspaces/{workspaceId}/brand-voice-file-imports

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Workspace-ID (uuid4)

Anfrage-Body

audienceModelIdstringJa

countrystringJa

fileContentstringJa

filenamestringJa

languagestringJa

mimeTypestringJa

Antwort

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

timeFormatstring

useControversialEmojisboolean

useHeaderPunctuationboolean

useHyphensboolean

vocabularyarray<string>

Beispiel

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

Antwort:

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

Erstellt einen Textimport, der ihn in eine Brand Voice konvertiert

POST/v1/workspaces/{workspaceId}/brand-voice-text-imports

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Workspace-ID (uuid4)

Anfrage-Body

audienceModelIdstringJa

countrystringJa

languagestringJa

textstringJa

Antwort

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

timeFormatstring

useControversialEmojisboolean

useHeaderPunctuationboolean

useHyphensboolean

vocabularyarray<string>

Beispiel

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

Antwort:

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

Erstellt einen URL-Import, der den Inhalt der angegebenen Seite analysiert und in eine Brand Voice konvertiert

POST/v1/workspaces/{workspaceId}/brand-voice-url-imports

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Workspace-ID (uuid4)

Anfrage-Body

audienceModelIdstringJa

countrystringJa

languagestringJa

urlstringJa

Antwort

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

timeFormatstring

useControversialEmojisboolean

useHeaderPunctuationboolean

useHyphensboolean

vocabularyarray<string>

Beispiel

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

Antwort:

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

Erstellt einen Dateiimport, der den Inhalt in eine Brand Voice konvertiert​

Pfadparameter​

Anfrage-Body​

Antwort​

Beispiel​

Erstellt einen Textimport, der ihn in eine Brand Voice konvertiert​

Pfadparameter​

Anfrage-Body​

Antwort​

Beispiel​

Erstellt einen URL-Import, der den Inhalt der angegebenen Seite analysiert und in eine Brand Voice konvertiert​

Pfadparameter​

Anfrage-Body​

Antwort​

Beispiel​

Erstellt einen Dateiimport, der den Inhalt in eine Brand Voice konvertiert

Pfadparameter

Anfrage-Body

Antwort

Beispiel

Erstellt einen Textimport, der ihn in eine Brand Voice konvertiert

Pfadparameter

Anfrage-Body

Antwort

Beispiel

Erstellt einen URL-Import, der den Inhalt der angegebenen Seite analysiert und in eine Brand Voice konvertiert

Pfadparameter

Anfrage-Body

Antwort

Beispiel