Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductSites and appsSite

Site routes: create, get, list

The Site Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Site, one group of Site routes.

Site.create

Creates a Site. Verb page.

Text
POST /{namespace}/sites

Body, as JSON: the inputs. Emits Site.created.

Inputs

InputTypeRequiredDescription
kindstringrequiredOne of api, mcp, cli, sdk, site, app, docs, or webhooks.
pathstringWhere it is mounted on its Domain, such as /api.
conformsTojsonThe Standards it also speaks, each mapping the Standard’s operations onto the Product’s Verbs.
navigationjsonThe menus that link its Pages.
brandBrandA Site renders one Brand’s name, voice and Theme.

Returns

OutputTypeRequiredDescription
siteSiterequiredThe Site.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/kilnbakery.com/sites \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"api"}'
JSON
{
  "api": "https://api.sb/kilnbakery.com",
  "site": {
    "$id": "https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab",
    "$type": "Site",
    "kind": "api"
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Site.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}

Site.get

Returns one Site by id. Verb page.

Text
GET /{namespace}/sites/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Site.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
siteSiterequiredThe Site.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/kilnbakery.com",
  "$type": "Site",
  "$id": "https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab",
  "site": {
    "$id": "https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab",
    "$type": "Site",
    "kind": "api"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab",
    "up": "https://api.sb/kilnbakery.com/sites"
  },
  "actions": {
    "publish": "https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab/publish"
  }
}

Site.list

Returns Sites, newest first, one page at a time. Verb page.

Text
GET /{namespace}/sites

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
siteslist of SiterequiredOne page of Sites.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/kilnbakery.com/sites?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/kilnbakery.com",
  "$type": "Site",
  "sites": [
    {
      "$id": "https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab",
      "$type": "Site",
      "kind": "api"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "site_kqt1HxwFab"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/sites?limit=20",
    "next": "https://api.sb/kilnbakery.com/sites?after=site_kqt1HxwFab"
  }
}

Site

Previous

update, delete

Next