Brand Voice-Zusammenfassungen

Brand Voice in ihre Prompt-Text-Zusammenfassung rendern

POST/api/v1/workspaces/{workspaceId}/brand-voice-summaries

Die Brand Voice mit der ID brandVoiceId in das Klartext-Fragment rendern, das die nachgelagerte LLM-Generierung steuert. Synchron; die Antwort ist der gerenderte String.

Ressource. Eine BrandVoiceSummary ist die gerenderte Textform einer Brand Voice — die deterministische Ausgabe des Renderers für eine gegebene Brand-Voice-ID. Der Aufruf dieses Endpunkts erstellt eine. Die Ausgabe ist über Aufrufe für dieselbe Brand Voice hinweg konsistent und eignet sich zum Inline-Einfügen in den System-Prompt eines nachgelagerten LLM-Aufrufs.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
workspaceId	string	Ja	Der Arbeitsbereich, auf den sich die Anfrage bezieht. Muss dem Workspace-Anspruch im Gateway-Token entsprechen.

Anfrage-Body

FeldTypErforderlichBeschreibung

brandVoiceIdstringJaKennung der Brand Voice, die zusammengefasst werden soll. Gibt 404 brandVoiceNotFound zurück, wenn die ID keine Brand Voice in diesem Arbeitsbereich entspricht, oder 403, wenn der Aufrufer kein Mitglied des Arbeitsbereichs ist.

Antwort

FeldTypBeschreibung

textstringGerenderter Klartext-Brand-Voice-Zusammenfassung, bereit zum Inline-Einfügen in den System-Prompt eines nachgelagerten LLM-Aufrufs. Das Format wird durch die serverseitige Vorlage festgelegt (aus shared_{env}.prompts_v1 für jeden Aufruf geladen) und ist über Aufrufe für dieselbe Brand Voice hinweg konsistent.

Beispiel

cURL

curl -X POST "https://app.neuroflash.com/api/v1/workspaces/{workspace_id}/brand-voice-summaries" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "brandVoiceId": "string"
  }'

Python

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/v1/workspaces/{workspace_id}/brand-voice-summaries",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "brandVoiceId": "string"
    },
).json()

Node.js

const response = await fetch(
  `https://app.neuroflash.com/api/v1/workspaces/${workspaceId}/brand-voice-summaries`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "brandVoiceId": "string"
    }),
  }
).then((r) => r.json());

Go

body, _ := json.Marshal(map[string]any{
		"brandVoiceId": "string",
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/v1/workspaces/"+workspaceID+"/brand-voice-summaries", 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:

{
  "text": "## **Brand Voice Dokumentation**\n..."
}