contentTemplates

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

Methods

pd.contentTemplates.list(input, init?)

List the content templates available to a workspace

GET /api/workspaces/{workspaceId}/content-templates

Returns the built-in templates (isSystem true, workspaceId null), which every workspace shares, together with the workspace's own, ordered by name. Requires templates.read.

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.contentTemplates.list({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.contentTemplates.create(input, init?)

Create a workspace content template

POST /api/workspaces/{workspaceId}/content-templates

Requires templates.create; answers 201 and records a templates.created audit entry. The slug is derived from the name and unique within the workspace: when it is taken, a random six-character suffix is added. Sections are required in order; the call to action closes the article. Generation follows the sections and the call to action; defaultWordCount and tone are defaults the web app pre-fills when the template is chosen.

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.contentTemplates.create({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    name: "example",
    sections: [
      {
        heading: "example",
        level: 2,
        purpose: "example",
      },
    ],
    defaultWordCount: 200,
  },
});
console.log(result);

pd.contentTemplates.update(input, init?)

Update a workspace content template

PATCH /api/workspaces/{workspaceId}/content-templates/{templateId}

Requires templates.update. Only the fields sent change; sections, when sent, replaces the whole list. Built-in templates answer 403: every workspace shares them. A template that does not exist or belongs to another workspace answers 404. The slug does not change. Records a templates.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.contentTemplates.update({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  templateId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.contentTemplates.delete(input, init?)

Delete a workspace content template

DELETE /api/workspaces/{workspaceId}/content-templates/{templateId}

Requires templates.delete. Built-in templates answer 403; a template that does not exist or belongs to another workspace answers 404. Articles that used the template keep their content; generating them again runs without its structure. Records a templates.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.contentTemplates.delete({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  templateId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);