blog

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

Methods

pd.blog.listPosts(input, init?)

The blog's published posts in one language

GET /api/blog/posts

Public: needs no session. Returns the published posts of the site's own blog project in one language, newest first. Drafts, articles of any other workspace and everything from the editing side (keywords, outlines, generation settings, authors, storage paths) are never exposed. The answer carries Cache-Control: public, max-age=60, so an unpublished post can stay visible for up to a minute.

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.blog.listPosts({
  locale: "en",
});
console.log(result);

pd.blog.listCategories(input, init?)

The categories that have published posts, in one language

GET /api/blog/categories

Public: needs no session. Returns the categories of the site's blog that carry at least one published post in the language, sorted by name, each with the number of such posts. A category with no name in the language appears under its primary-language name. Cached for up to a minute (Cache-Control: public, max-age=60).

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.blog.listCategories({
  locale: "en",
});
console.log(result);

pd.blog.getPost(input, init?)

One published post

GET /api/blog/posts/{slug}

Public: needs no session. Returns one published post of the site's blog with its body, images and the blog pages of the posts it links to. Answers 404 when no published post matches. A slug that was the old address of a renamed post resolves to that post and the returned slug is the current one, so a caller can redirect. Without language, the earliest published post with that slug wins. Cached for up to a minute (Cache-Control: public, max-age=60).

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.blog.getPost({
  slug: "example",
});
console.log(result);

pd.blog.getPostEdit(input, init?)

Where the caller can edit a published post

GET /api/blog/posts/{slug}/edit

Not public: needs a session or API key. Returns the workspace and article ids behind a published post, so a signed-in member can open it in the editor; the public post carries neither. The workspace is read from the article, never from the request, and the caller needs articles.update on it. Answers 404 when no published post has the slug (an old, redirected slug does not match) or when the caller is not a member of the blog's workspace, and 403 when a member lacks the permission. Not cached.

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.blog.getPostEdit({
  slug: "example",
});
console.log(result);