Brand Voice Summaries

Render a brand voice to its prompt-text summary

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

Render the brand voice identified by brandVoiceId into the plain-text fragment used to steer downstream LLM generation. Synchronous; the response is the rendered string.

Resource. A BrandVoiceSummary is the rendered textual form of a brand voice — the deterministic output of the renderer for a given brand voice id. Calling this endpoint creates one. The output is consistent across calls for the same brand voice and is suitable to inline into the system prompt of a downstream LLM call.

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	The workspace the request operates on. Must match the workspace claim in the gateway token.

Request Body

FieldTypeRequiredDescription

brandVoiceIdstringYesIdentifier of the brand voice to summarise. Returns 404 brandVoiceNotFound when the id does not match a brand voice in this workspace, or 403 when the caller is not a member of the workspace.

Response

FieldTypeDescription

textstringRendered plaintext brand-voice summary, ready to inline into the system prompt of a downstream LLM call. The format is fixed by the service-side template (loaded from shared_{env}.prompts_v1 for every call) and is consistent across calls for the same brand voice.

Example

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

Response:

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