Skip to content

by Startups.Studio

OverviewStartup

Startup.read

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

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

Noun: Startup
Mode: do
Event: Startup.read

You, to your agent

Read PatentPad.

curl -X POST https://api.sb/patentpad.com/startups/startup_1/read \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scope":"diligence"}'

import { $ } from 'startup-builder'

const { room, gaps, startup } = await $.Startup.read({ startup: 'startup_1', scope: 'diligence' })

npx startup-builder do Startup.read --json '{"startup":"startup_1","scope":"diligence"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Startup.read({ startup: 'startup_1', scope: 'diligence' })"
  }
}

Inputs

Input	Type	Required	Description
`startup`	Startup	required	The Startup to read.
`scope`	`string`	required	What the room holds: `diligence` for a raise, a sale or an LP look-through.
`reader`	Party		Who reads it; access is a Permission that expires, readable over MCP.

Outputs

Output	Type	Required	Description
`room`	`json`	required	Statements, Metrics, cap table, Agreements in force, Control Proofs and open Disputes, each linked to its record.
`gaps`	`json`	required	Each failed readiness check with its fix, such as a Period still open.
`startup`	Startup	required	The Startup the room was compiled from.

Effects

Emits Startup.read.
Two-way: it runs at once, in the try, send and do modes.
Compiles from records and never from uploads: each document is its signed Version.
Runs the readiness checks: three Periods closed in a row, cap table reconciled to signed Agreements, IP assigned, Controls passing.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Startup.read

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.