Skip to content

by Startups.Studio

OverviewStartup

Startup.import

POST /{namespace}/startups/import

Import builds a new Startup from an existing business’s definition: its Offers, Pages, Nouns and Processes.

Noun: Startup
Mode: do
Event: Startup.imported

You, to your agent

Import Kiln Bakery.

curl -X POST https://api.sb/kilnbakery.com/startups/import \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"https://kilnbakery.com"}'

import { $ } from 'startup-builder'

const startup = await $.Startup.import({ source: 'https://kilnbakery.com' })

npx startup-builder do Startup.import --json '{"source":"https://kilnbakery.com"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Startup.import({ source: 'https://kilnbakery.com' })"
  }
}

Inputs

Input	Type	Required	Description
`source`	`url`	required	The existing business’s site or export.
`template`	Template		The Template to map the definition onto.

Outputs

Output	Type	Required	Description
`startup`	Startup	required	The new Startup, in Idea.

Effects

Emits Startup.imported.
Performed by the Integration Engineer.
Leaves the source business unchanged.
Marks every imported fact with its source.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	Startup.import
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.import
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Startup.import

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`.