Skip to content

by Startups.Studio

Core grammar File

File.update

PATCH /{namespace}/files/{id}

Changes the given properties of a File.

Noun: File
Mode: do
Event: File.updated

You, to your agent

Change the latest file.

curl -X PATCH https://api.sb/shiftnote.app/files/file_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"size":1}'

import { $ } from 'startup-builder'

const file = await $.File.update({ id: 'file_1', size: 1 })

npx startup-builder do File.update --json '{"id":"file_1","size":1}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.File.update({ id: 'file_1', size: 1 })"
  }
}

Update changes the given properties of a File. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the File.
`contentType`	`string`		The media type, such as `application/pdf`.
`size`	`integer`		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`.

Outputs

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

Effects

Emits File.updated.
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.update

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

Previous Page

Function

Next Page