Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthStory

Story routes: create, get, list

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

Reference for Story, one group of Story routes.

Story.create

Creates a Story. Verb page.

Text
POST /{namespace}/stories

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

Inputs

InputTypeRequiredDescription
icpICPrequiredThe ICP it speaks to: one Story per ICP.
herotextrequiredWho the customer is and what they want.
problemProblemrequiredThe Problem: external, internal, and the villain behind it.
guidetextThe Startup’s empathy and authority, the authority read from Metrics and Evidence.
plantextThree steps, each naming a declared Event.
successtextWhat the customer gains.
failuretextWhat the customer risks without it.
oneLinerstringThe Story in one sentence.
directOfferThe direct call to action: an Offer that makes a Customer.
transitionalFunnelThe transitional call to action: a Funnel opt-in that makes a Lead.
fromstringrequiredLineage: the slot it compiles from, as Hypothesis#<slot>@v<version>.
stancestringThe positioning the Positioning tournament chose, graded Behavior; every compiled asset recompiles when it changes.
categorystringThe market category name the Story claims, as answer engines repeat it.
hypothesisHypothesisThe Founding Hypothesis whose slots the Story compiles from; a pivot recompiles it.

Returns

OutputTypeRequiredDescription
storyStoryrequiredThe Story.

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/stories \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"icp":"icp_EwhsJU4AOW","hero":"Example hero","problem":"problem_UzvXXfKsJB","from":"Hypothesis#approach@v1"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "story": {
    "$id": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
    "$type": "Story",
    "icp": "icp_EwhsJU4AOW",
    "hero": "Example hero",
    "problem": "problem_UzvXXfKsJB",
    "from": "Hypothesis#approach@v1"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Story.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Story.get

Returns one Story by id. Verb page.

Text
GET /{namespace}/stories/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
storyStoryrequiredThe Story.

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/stories/story_ujkz1xjvrp \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Story",
  "$id": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
  "story": {
    "$id": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
    "$type": "Story",
    "icp": "icp_EwhsJU4AOW",
    "hero": "Example hero",
    "problem": "problem_UzvXXfKsJB",
    "from": "Hypothesis#approach@v1"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
    "up": "https://api.sb/leaseline.app/stories"
  }
}

Story.list

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

Text
GET /{namespace}/stories

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
storieslist of StoryrequiredOne page of Stories.

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/stories?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Story",
  "stories": [
    {
      "$id": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
      "$type": "Story",
      "icp": "icp_EwhsJU4AOW",
      "hero": "Example hero",
      "problem": "problem_UzvXXfKsJB",
      "from": "Hypothesis#approach@v1"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "story_ujkz1xjvrp"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/stories?limit=20",
    "next": "https://api.sb/leaseline.app/stories?after=story_ujkz1xjvrp"
  }
}

Story

Previous

update, delete

Next