Skip to content
StartupBuilderby Startups.Studio
Business
Changelog
ProductWhat you sell

Publication

A Publication is the branded package a Startup’s Customers use: Domain, Interfaces, packages, docs and Portal, compiled from its Brand and a Version.

Nothing inside it names the platform.

Properties

PropertyTypeRequiredDescription
brandBrandrequiredThe Brand every surface carries.
versionVersionrequiredThe Version it compiles from; a restyle compiles a new Publication and leaves the API version alone.
domainDomainrequiredThe canonical Domain every surface answers on.
apiurlrequiredWhere the API answers: /api on the Domain. api. on the Domain is an alias that serves the same API.
mcpurlrequiredWhere the MCP server answers: /mcp on the Domain.
docsurlrequiredThe docs, with llms.txt and Markdown per page.
statusPageurlThe status page, with every Incident that touched an Interface.
portalurlThe Portal, where a Customer manages keys, usage, billing and Tenant settings.
packagesjsonThe SDK, CLI and MCP package names, one per language and package registry.
keyPrefixstringThe Brand prefix on every API key, ahead of the fixed pattern secret scanners match.
envPrefixstringThe prefix of the key variable the SDK and CLI read, such as TRANSCRIBE_API_KEY.
webhookHeaderstringThe signature header on every webhook delivery to a Customer.
errorNamespaceurlThe base of every error type a Customer reads, on the Domain.

Object

JSON
{
  "$id": "https://api.sb/petpantry.shop/publications/publication_1",
  "$type": "Publication",
  "brand": "brand_1",
  "version": "version_1",
  "domain": "domain_1",
  "api": "https://transcribe.fm/api",
  "mcp": "https://transcribe.fm/mcp",
  "docs": "https://transcribe.fm/docs",
  "statusPage": "https://transcribe.fm/status",
  "portal": "https://transcribe.fm/portal",
  "packages": {
    "npm": "transcribe",
    "pypi": "transcribe"
  },
  "keyPrefix": "transcribe_sk_live_",
  "envPrefix": "TRANSCRIBE_",
  "webhookHeader": "Transcribe-Signature",
  "errorNamespace": "https://transcribe.fm/errors"
}

Relationships

Verbs

  1. getReturns one Publication by id.
    GET /{namespace}/publications/{id}readNo Event
  2. listReturns Publications, newest first, one page at a time.
    GET /{namespace}/publicationsreadNo Event

A Publication is kept forever and never edited: it has no update or delete.

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Publication.getYesYesYesYes
Publication.listYesYesYesYes

Call it

Text
Show me the latest publication.

Example

JSON
{
  "$id": "https://api.sb/transcribe.fm/publications/publication_1",
  "$type": "Publication",
  "domain": "domain_1",
  "api": "https://transcribe.fm/api",
  "mcp": "https://transcribe.fm/mcp",
  "docs": "https://transcribe.fm/docs",
  "statusPage": "https://transcribe.fm/status",
  "portal": "https://transcribe.fm/portal",
  "packages": { "npm": "transcribe", "pypi": "transcribe" },
  "keyPrefix": "transcribe_sk_live_",
  "envPrefix": "TRANSCRIBE_",
  "webhookHeader": "Transcribe-Signature",
  "errorNamespace": "https://transcribe.fm/errors"
}

Software.update

Previous Page

Publication.get

Next Page