Skip to content

by Startups.Studio

Core grammar Document

Document.create

POST /{namespace}/documents

Creates a Document.

Noun: Document
Mode: do
Event: Document.created

You, to your agent

Add a document to LedgerLark.

curl -X POST https://api.sb/ledgerlark.com/documents \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"form":"document"}'

import { $ } from 'startup-builder'

const document = await $.Document.create({ form: 'document' })

npx startup-builder do Document.create --json '{"form":"document"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Document.create({ form: 'document' })"
  }
}

Create makes a new Document from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`form`	`string`	required	One of `document`, `deck`, or `sheet`.
`template`	Template		A Template fills its variables from the graph to generate a Document, such as a proposal or an invoice.

Outputs

Output	Type	Required	Description
`document`	Document	required	The Document.

Effects

Emits Document.created.
Two-way: try, send, do.

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.	Document.create

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

Document

Previous Page

Document.delete

Next Page