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

Startup routes: pause, pivot, read, resume

The Startup Verbs pause, pivot, read, resume as api.sb routes, with inputs, result, refusals and an example.

Reference for Startup, one group of Startup routes.

Startup.pause

Pause moves a Startup to Dormant: its scheduled Workflows stop, and its Sites and records stay in place. Verb page.

Text
POST /{namespace}/startups/{startup}/pause

Path: startup. Body, as JSON: the other inputs. Emits Startup.paused.

Inputs

InputTypeRequiredDescription
startupStartuprequiredThe Startup to pause.
reasontextWhy the Startup pauses.

Returns

OutputTypeRequiredDescription
startupStartuprequiredThe Startup, now Dormant.

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.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY/pause \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "startup": {
    "$id": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY",
    "$type": "Startup",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Startup.pause",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Startup.pivot

Pivot records a founder Decision, on an Experiment’s Evidence against one slot Hypothesis, and merges the new Founding Hypothesis Version. Verb page.

Text
POST /{namespace}/startups/{startup}/pivot

Path: startup. Body, as JSON: the other inputs. Emits Startup.pivoted.

Inputs

InputTypeRequiredDescription
startupStartuprequiredThe Startup that pivots, in any state from Building to Scale.
hypothesisHypothesisrequiredThe slot Hypothesis the Evidence went against: customer, problem, approach, switch or differentiation.
experimentExperimentrequiredThe Experiment whose Evidence the Decision cites; it tested that Hypothesis.
decisionDecisionrequiredThe founder’s pivot Decision, citing the Evidence behind it.

Returns

OutputTypeRequiredDescription
startupStartuprequiredThe Startup, in the Lifecycle state it held.

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.
Unless the Experiment tested the named Hypothesis; a field change never starts a pivotrefusedClear what the check names, then call it again.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY/pivot \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"hypothesis":"hypothesis_Z1gjx1kbtc","experiment":"experiment_IyIJJPngKt","decision":"decision_ipoch3tTJh"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "startup": {
    "$id": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY",
    "$type": "Startup",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Startup.pivot",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Startup.read

Read compiles a Startup’s records into one scoped room, such as a diligence room, with every number citing its Proof. Verb page.

Text
POST /{namespace}/startups/{startup}/read

Path: startup. Body, as JSON: the other inputs. Emits Startup.read.

Inputs

InputTypeRequiredDescription
startupStartuprequiredThe Startup to read.
scopestringrequiredWhat the room holds: diligence for a raise, a sale or an LP look-through.
readerPartyWho reads it; access is a Permission that expires, readable over MCP.

Returns

OutputTypeRequiredDescription
roomjsonrequiredStatements, Metrics, cap table, Agreements in force, Control Proofs and open Disputes, each linked to its record.
gapsjsonrequiredEach failed readiness check with its fix, such as a Period still open.
startupStartuprequiredThe Startup the room was compiled from.

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/startups/startup_l3hr1EnUGY/read \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scope":"diligence"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "room": {},
  "gaps": {},
  "startup": {
    "$id": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY",
    "$type": "Startup",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Startup.read",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Startup.resume

Resume returns a Dormant Startup to the Lifecycle state it held when it paused. Verb page.

Text
POST /{namespace}/startups/{startup}/resume

Path: startup. Emits Startup.resumed.

Inputs

InputTypeRequiredDescription
startupStartuprequiredThe Dormant Startup.

Returns

OutputTypeRequiredDescription
startupStartuprequiredThe Startup in its prior state.

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.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY/resume \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "startup": {
    "$id": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY",
    "$type": "Startup",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Startup.resume",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

claim, clone, hold, import

Previous

Startup Template

Next