plans

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

Methods

pd.plans.suggest(input, init?)

Suggest a publishing plan

POST /api/projects/{projectId}/plans/suggest

Asks the model for articles for the project, one per slot of the cadence, and sets each on its day. Slots follow the cadence's weekdays from startsOn, read on the wall of timezone, and scheduledFor is each slot as a UTC instant. The project's last 60 titles, as ideas or articles, are not repeated, nor is one title twice. Nothing is stored: confirm the result, edited if need be, with plans.create. Requires articles.create on the project. Costs 1 credit per model call that brought new ideas (at most one call per 12 slots, plus one more when the first came up short): the credits are reserved first, 402 INSUFFICIENT_CREDITS when the balance cannot cover them, and the ones for a call that brought nothing are released. 429 QUOTA_EXCEEDED when the ai_operations quota is used up. 400 when the first slot is already in the past (nothing is reserved or charged). The answer holds fewer suggestions than slots when the model had too few new ideas; estimate is for the suggestions returned and is the most writing them costs, not a charge.

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.plans.suggest({
  projectId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    postsPerWeek: 1,
    weeks: 1,
    startsOn: "example",
    runTime: "example",
    timezone: "example",
  },
});
console.log(result);

pd.plans.create(input, init?)

Create a publishing plan

POST /api/projects/{projectId}/plans

Saves a plan: one idea and one calendar item per entry of items, the item set on its localDate at runTime in timezone with its status planned and its runState pending, all or nothing. Requires articles.create on the project. 400 when a slot is already in the past, 409 CONFLICT with details.reason plan_limit when the workspace already has 3 open plans (active or paused; the plans of an archived project are not counted). A plan costs nothing to save. With autopilot on, each article is written, approved and published on its day (see autopilot below); otherwise nothing runs. creditCap and estimatedCredits default to the quote of writing every item. Sending the same idempotencyKey again answers 200 with the plan the first call made, and stores nothing, even when its first slot has passed since; a new plan answers 201. A key already used for a plan of another project answers 409 CONFLICT with details.reason idempotency_key_reused. With autopilot on, 400 INVALID_REQUEST with details.reason autopilot_off when the platform has switched autopilot off.

Input

Returns 200 OK, 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.plans.create({
  projectId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    postsPerWeek: 1,
    weeks: 1,
    startsOn: "example",
    runTime: "example",
    timezone: "example",
    items: [
      {
        title: "example",
        localDate: "example",
      },
    ],
    idempotencyKey: "example",
  },
});
console.log(result);

pd.plans.list(input, init?)

List publishing plans

GET /api/workspaces/{workspaceId}/plans

Returns the workspace's plans, newest first, each with its progress counts; the list is not paginated. Requires articles.read. Plans of projects the caller cannot access are left out.

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

pd.plans.get(input, init?)

Read a publishing plan

GET /api/workspaces/{workspaceId}/plans/{planId}

Returns the plan and its calendar items, earliest first. Requires articles.read on the plan's project; 403 for a caller who is not a member of a restricted project, 404 when the plan is not in the workspace.

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

pd.plans.update(input, init?)

Change a publishing plan

PATCH /api/workspaces/{workspaceId}/plans/{planId}

Renames the plan, changes its credit cap, changes the time of day of its slots (runTime, see the field), turns autopilot on or off (see the field), pauses it (paused, reason manual), resumes it (active) or cancels it (cancelled). Cancelling is final: items that have not started become skipped. An item whose run is already going becomes skipped when that run ends: its article is left as it is for a person, and nothing is approved or published for a cancelled plan (an article already live stays live). A cancelled or completed plan answers 409 CONFLICT with details.reason plan_closed to any status change. A request that changes nothing answers 200 with the plan as it is and records no audit entry. Requires articles.update on the plan's project. The plan of an archived project can only be cancelled, with a body of { "status": "cancelled" } and nothing else; any other change to it answers 409 CONFLICT. 400 when the body names no field, and 400 INVALID_REQUEST with details.reason autopilot_off when it turns autopilot on, or resumes an autopilot plan, while the platform has autopilot switched off.

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