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

Hypothesis routes: create, get, list

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

Reference for Hypothesis, one group of Hypothesis routes.

Hypothesis.create

Creates a Hypothesis. Verb page.

Text
POST /{namespace}/hypotheses

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

Inputs

InputTypeRequiredDescription
statementtextrequiredThe belief, in one sentence.
kindstringrequiredOne of founding, the five slots (customer, problem, approach, switch, differentiation), or loop.
parentHypothesisThe Founding Hypothesis a slot Hypothesis belongs to.
metricMetricThe Metric that settles it.
thresholdstringThe Metric value that settles it.
gradestringComputed: the strongest grade of its outside Evidence, None without any.

Returns

OutputTypeRequiredDescription
hypothesisHypothesisrequiredThe Hypothesis.

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/hypotheses \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"statement":"Tracks lease renewals for small property managers.","kind":"founding"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "hypothesis": {
    "$id": "https://api.sb/leaseline.app/hypotheses/hypothesis_Z1gjx1kbtc",
    "$type": "Hypothesis",
    "statement": "Tracks lease renewals for small property managers.",
    "kind": "founding",
    "verdict": "Open",
    "version": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Hypothesis.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Hypothesis.get

Returns one Hypothesis by id. Verb page.

Text
GET /{namespace}/hypotheses/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
hypothesisHypothesisrequiredThe Hypothesis.

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/hypotheses/hypothesis_Z1gjx1kbtc \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Hypothesis",
  "$id": "https://api.sb/leaseline.app/hypotheses/hypothesis_Z1gjx1kbtc",
  "hypothesis": {
    "$id": "https://api.sb/leaseline.app/hypotheses/hypothesis_Z1gjx1kbtc",
    "$type": "Hypothesis",
    "statement": "Tracks lease renewals for small property managers.",
    "kind": "founding",
    "verdict": "Open",
    "version": 1
  },
  "links": {
    "self": "https://api.sb/leaseline.app/hypotheses/hypothesis_Z1gjx1kbtc",
    "up": "https://api.sb/leaseline.app/hypotheses"
  },
  "actions": {
    "drop": "https://api.sb/leaseline.app/hypotheses/hypothesis_Z1gjx1kbtc/drop",
    "test": "https://api.sb/leaseline.app/hypotheses/hypothesis_Z1gjx1kbtc/test"
  }
}

Hypothesis.list

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

Text
GET /{namespace}/hypotheses

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
hypotheseslist of HypothesisrequiredOne page of Hypotheses.

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/hypotheses?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Hypothesis",
  "hypotheses": [
    {
      "$id": "https://api.sb/leaseline.app/hypotheses/hypothesis_Z1gjx1kbtc",
      "$type": "Hypothesis",
      "statement": "Tracks lease renewals for small property managers.",
      "kind": "founding",
      "verdict": "Open",
      "version": 1
    }
  ],
  "meta": {
    "limit": 20,
    "after": "hypothesis_Z1gjx1kbtc"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/hypotheses?limit=20",
    "next": "https://api.sb/leaseline.app/hypotheses?after=hypothesis_Z1gjx1kbtc"
  }
}

Hypothesis

Previous

drop, test

Next