Skip to content

by Startups.Studio

Core grammar File

File.create

POST /{namespace}/files

Creates a File.

Noun: File
Mode: do
Event: File.created

You, to your agent

Add a file to QuietCopy.

curl -X POST https://api.sb/quietcopy.com/files \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contentType":"Example content type","size":1}'

import { $ } from 'startup-builder'

const file = await $.File.create({ contentType: 'Example content type', size: 1 })

npx startup-builder do File.create --json '{"contentType":"Example content type","size":1}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.File.create({ contentType: 'Example content type', size: 1 })"
  }
}

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

Inputs

Input	Type	Required	Description
`contentType`	`string`	required	The media type, such as `application/pdf`.
`size`	`integer`	required	The size in bytes.
`name`	`string`		The file name it was uploaded with.
`visibility`	`string`		Who may read it: `Owner`, `Customer`, or `Public`. The default is `Owner`.
`document`	Document		Each rendering of a Document to a format, such as PDF, is stored as a File.

Outputs

Output	Type	Required	Description
`file`	File	required	The File.

Effects

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

File

Previous Page

File.delete

Next Page