ideas

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

Methods

pd.ideas.list(input, init?)

List content ideas

GET /api/workspaces/{workspaceId}/ideas

Returns the workspace's content ideas ordered by priority (lowest number first), then newest first; the list is not paginated. Requires articles.read; with projectId, on that project (403 for a caller who is not one of its members; 404 RESOURCE_NOT_FOUND for a project that does not exist or belongs to another workspace), and without it the ideas of projects the caller cannot access are left out. An idea has no status of its own: it is open while its articleId is null and written once an article was created from it.

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

pd.ideas.create(input, init?)

Create a content idea

POST /api/workspaces/{workspaceId}/ideas

Stores an idea by hand. Requires articles.create in the workspace, and on projectId when one is sent: a foreign project answers 404 and an archived one 409. An idea becomes an article through articles.create, which takes the idea's ideaId and sets its articleId; this call cannot set it. Answers 201.

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

pd.ideas.update(input, init?)

Update a content idea

PATCH /api/workspaces/{workspaceId}/ideas/{ideaId}

Changes the fields sent and keeps the others; null clears searchIntent and projectId. Requires articles.update, checked against the new projectId when one is sent and against the idea's current project and article: 403 for a caller who is not a member of a restricted project, 409 when that project is archived. 404 when the idea is not in the workspace. articleId cannot be changed here: only creating an article from the idea sets it.

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

pd.ideas.delete(input, init?)

Delete a content idea

DELETE /api/workspaces/{workspaceId}/ideas/{ideaId}

Deletes the idea. Requires articles.delete, on the idea's project and article when it has them (403 for a caller who is not a member of a restricted project, 409 when it is archived). An article written from it is untouched, and a stored brief that named it keeps its content and loses the link. 404 when the idea 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.ideas.delete({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  ideaId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.ideas.generate(input, init?)

Suggest content ideas for a project

POST /api/projects/{projectId}/ideas/generate

Asks the model for up to 8 article ideas drawn from the project's profile (name, description, industry, audience, website and language) and stores them as ideas of the project with priority 3. The 60 most recent titles the project already has, as ideas or articles, are not repeated. Search volume and difficulty are never invented. Requires articles.create on the project. Costs 1 credit, reserved before the model is called, charged when at least one idea is stored, and released when none comes back or the call fails: 402 INSUFFICIENT_CREDITS when the balance cannot cover it, 429 QUOTA_EXCEEDED when the ai_operations quota is used up. Answers 201, with an empty ideas list when nothing new came back.

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