Platform

Build on top of calm profiles and structured shelves

This area documents what you can rely on when you connect your own tools. We keep the service small on purpose, so the contract surface is easy to reason about.

Read-first

We favour stable GET endpoints and clear cache headers. Breaking changes are announced on the status page with a date.

Auth you control

When your deployment adds API keys or JWT, they are scoped to the workspace that issued them. Never share keys in client-side code.

Shelves as lists

Bookmarks export conceptually as ordered arrays: title, URL, optional note, and tags. If you can model JSON, you can model a shelf.

Documented public endpoints (snapshot)

All paths are relative to your project origin. The following table is a marketing snapshot—treat the running deployment as the source of truth.

MethodPathUse
GET/api/seo/link-healthLightweight head checks for public URLs in your posts (read-only, rate limited).
GET/sitemap.xmlMachine-readable list of public routes. Same shape you would expect for search engine discovery.
Webhooks & eventing (roadmap)

Many teams ask for “something changed on this profile” style hooks. The shape we are most likely to ship first: a signed POST to your endpoint with { "event", "objectId", "occurredAt" }. If you are planning an integration, tell us in contact which events matter so we can line up a beta cohort.

Embed example

GET https://pkkwb.com/search?q=design%20shelf
# Returns HTML with card surfaces you can also discover via
# the same public routes a browser would use. Prefer linking out
# instead of hot-linking our assets in production front-ends.

Replace the base URL in your own deployment. Caching: respect the Cache-Control you receive; do not pin assets longer than the header suggests.

    Developers — Pkkwb | Pkkwb