brandVoices

The methods of pd.brandVoices. Inputs and outputs are described in Conventions; every method can also fail as described in Errors.

Methods

pd.brandVoices.list(input, init?)

List brand voices

GET /api/workspaces/{workspaceId}/brand-voices

Requires brand_voices.read. Returns the workspace's brand voices, default voices first, then by name. With projectId, only the voices scoped to that project are returned.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.brandVoices.list({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.brandVoices.create(input, init?)

Create a brand voice

POST /api/workspaces/{workspaceId}/brand-voices

Requires brand_voices.create; answers 201 and records a brand_voices.created audit entry. A brand voice is a reusable style profile that generation turns into writing instructions. A name already used in the workspace answers 409, and a projectId outside the workspace answers 404. With isDefault true the voice becomes the default of its scope and the previous default stops being one.

Input

Returns 201 Created

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.brandVoices.create({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    name: "example",
  },
});
console.log(result);

pd.brandVoices.update(input, init?)

Update a brand voice

PATCH /api/workspaces/{workspaceId}/brand-voices/{voiceId}

Requires brand_voices.update. Only the fields sent change; an array field, when sent, replaces the stored list. A voice that does not exist or belongs to another workspace answers 404. With isDefault true the voice becomes the default of its scope and the previous default stops being one. Records a brand_voices.updated audit entry.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.brandVoices.update({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  voiceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.brandVoices.delete(input, init?)

Delete a brand voice

DELETE /api/workspaces/{workspaceId}/brand-voices/{voiceId}

Requires brand_voices.delete; a voice that does not exist or belongs to another workspace answers 404. A generation that names the deleted voice falls back to the project's default voice, then the workspace default. Records a brand_voices.deleted audit entry.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.brandVoices.delete({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  voiceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);