Polyblog API 1.0.0

GET/api/articles

List articles

Lists the articles of a blog. Requires the articles:read scope. Anonymous (unauthenticated) callers only ever see published articles; drafts are visible only to an API key or operator token of the owning organization.

Parameters

Responses

POST/api/articles

Create or update an article

Creates an article (or updates one when the body carries an existing _id). Requires the articles:write scope. Fires the article.created webhook.

Request body application/json

Responses

GET/api/articles/{idOrSlug}

Get an article

Returns a single article by id or slug. Requires the articles:read scope. An article belonging to another organization responds 404 so ids cannot be probed. Anonymous callers can only read a published article; a draft responds 404 unless the caller is an API key or operator token of the owning organization.

Parameters

Responses

POST/api/articles/generate

Generate an article with AI

Generates (and by default publishes) an SEO article for a blog. Requires the articles:write scope. Fires the article.created webhook when the generated article is persisted.

Responses

DELETE/api/articles/{articleId}

Delete an article

Deletes an article. Requires the articles:write scope. An article owned by another organization responds 404. Fires the article.deleted webhook.

Parameters

Responses

GET/api/blogs

List blogs

Lists the blogs of your organization. Requires the blogs:read scope.

Responses

POST/api/blogs

Create a blog

Creates a blog for your organization. Requires the blogs:write scope. Fires the blog.created webhook.

Responses

PUT/api/blogs/{blogId}

Update a blog

Updates a blog owned by your organization. Requires the blogs:write scope.

Parameters

Responses

GET/blogs

get blog details

returns a blog details

Parameters

Responses

GET/api/topics

List topic ideas

Lists the topic ideas of a blog you own. Requires the topics:read scope.

Parameters

Responses

GET/api/webhooksubscriptions

List webhook subscriptions

Webhook subscriptions deliver article.created, article.updated, article.deleted, blog.created and contact.created events to your server as signed POST requests (X-Polyblog-Signature: t=<timestamp>,v1=<hex HMAC-SHA256 of "timestamp.body">). An endpoint failing 20 times in a row is disabled automatically. Subscriptions are managed with an operator access token; the secret is only returned once, on create.

Responses

POST/api/webhooksubscriptions

Create a webhook subscription

Pass a blogId to receive only that blog's events, or omit it for an organization-wide subscription. The response includes the signing secret exactly once — store it; it cannot be retrieved again.

Request body application/json

Responses

PUT/api/webhooksubscriptions/{webhookSubscriptionId}

Update a webhook subscription

url, events and active are editable; the secret, organization and blog are immutable. Re-enabling an auto-disabled endpoint is done by setting active back to true.

Parameters

Responses

DELETE/api/webhooksubscriptions/{webhookSubscriptionId}

Delete a webhook subscription

Parameters

Responses