Skip to content

by Startups.Studio

Core grammar Document

Document.render

POST /{namespace}/documents/{document}/render

Render produces a file from a Document in the format the reader asks for.

Noun: Document
Mode: do
Event: Document.rendered

You, to your agent

Render the latest document.

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

import { $ } from 'startup-builder'

const { file, document } = await $.Document.render({ document: 'document_1', format: 'Example format' })

npx startup-builder do Document.render --json '{"document":"document_1","format":"Example format"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Document.render({ document: 'document_1', format: 'Example format' })"
  }
}

Inputs

Input	Type	Required	Description
`document`	Document	required	The Document to render.
`format`	`string`	required	The file format.

Outputs

Output	Type	Required	Description
`file`	`url`	required	Where the file lives.
`document`	Document	required	The Document rendered.

Effects

Emits Document.rendered.

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

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

Previous Page

Document.update

Next Page