Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarProduct Template

Product Template routes: create, get, list

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

Reference for Product Template, one group of Product Template routes.

ProductTemplate.create

Creates a Product Template. Verb page.

Text
POST /{namespace}/product-templates

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

Inputs

InputTypeRequiredDescription
slugstringrequiredThe page path under /start/templates/products.
kindstringrequiredThe abstract Product: data, software, agent, or service.
supplystringrequiredWho supplies the work: digital, which is unlimited, or human, which is recruited and credentialed.
workerstringrequiredWho does the work: agents, humans, or agents-and-humans.
buyerstringrequiredWho buys: human, agent, or human-or-agent.
earningModelstringrequiredHow it earns: subscription, usage, commerce, marketplace, or directory.
assurancetextWhat the buyer can rely on, in one sentence.

Returns

OutputTypeRequiredDescription
productTemplateProduct TemplaterequiredThe Product Template.

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/leaseline.app/product-templates \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"leaseline","kind":"data","supply":"Example supply","worker":"agents","buyer":"human","earningModel":"subscription"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "productTemplate": {
    "$id": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
    "$type": "ProductTemplate",
    "slug": "leaseline",
    "kind": "data",
    "supply": "Example supply",
    "worker": "agents"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "ProductTemplate.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

ProductTemplate.get

Returns one Product Template by id. Verb page.

Text
GET /{namespace}/product-templates/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
productTemplateProduct TemplaterequiredThe Product Template.

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/leaseline.app/product-templates/ptpl_mLTPhHFQYD \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "ProductTemplate",
  "$id": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
  "productTemplate": {
    "$id": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
    "$type": "ProductTemplate",
    "slug": "leaseline",
    "kind": "data",
    "supply": "Example supply",
    "worker": "agents"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
    "up": "https://api.sb/leaseline.app/product-templates"
  }
}

ProductTemplate.list

Returns Product Templates, newest first, one page at a time. Verb page.

Text
GET /{namespace}/product-templates

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
productTemplateslist of Product TemplaterequiredOne page of Product Templates.

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/leaseline.app/product-templates?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "ProductTemplate",
  "productTemplates": [
    {
      "$id": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
      "$type": "ProductTemplate",
      "slug": "leaseline",
      "kind": "data",
      "supply": "Example supply",
      "worker": "agents"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "ptpl_mLTPhHFQYD"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/product-templates?limit=20",
    "next": "https://api.sb/leaseline.app/product-templates?after=ptpl_mLTPhHFQYD"
  }
}

Product Template

Previous

update, delete

Next