Skip to main content

Developer overview

post.buzz exposes a versioned REST API under /api/v1/... for integrating publishing, account management, and media into your own tooling. It's authenticated with API keys and returns JSON.

Base URL

All REST endpoints are mounted under /api on your API origin, so the effective paths are /api/v1/.... The exact host depends on your deployment (the same origin that serves the app also serves the API).

https://<your-api-origin>/api/v1/...

REST vs tRPC

post.buzz's own frontend talks to the backend over tRPC at /api/trpc, which gives it end-to-end type safety. The REST API is a thinner, stable, publicly-documented surface that mirrors the most useful operations (create post, list posts, list accounts, upload media). It's the right choice for third-party integrations, automation scripts, and anything that isn't part of the post.buzz frontend.

REST APItRPC
Path/api/v1/.../api/trpc/...
AuthAPI key (Bearer)Session cookie
Use forExternal integrations(internal)
StabilityVersioned, documentedFluid

What's available

EndpointMethodPurpose
/v1/postsGETList your posts
/v1/postsPOSTCreate / schedule / cross-post
/v1/posts/:idDELETEDelete a draft or scheduled post
/v1/accountsGETList connected accounts
MediaPresigned upload + media record

Conventions

  • JSON in, JSON out. Request bodies are application/json; responses are application/json.
  • Validation. Each route validates input against a schema. Invalid input returns 400 with a details array before the handler runs.
  • Pagination. List endpoints accept limit and offset query params.
  • Errors. Consistent error shape — see Errors.
  • Limits. Creating a post runs the same per-platform limit validation as the app. See Limits.

Next

  1. Authentication — get and use an API key.
  2. REST API — conventions in depth.
  3. Posts — the core endpoint.