Skip to content

by Startups.Studio

Core grammar File

File.edit

POST /{namespace}/files/{file}/edit

Edit makes a new File from an existing one by instruction, such as upscaling or animating a still, and leaves the source unchanged.

Noun: File
Mode: do
Event: File.edited

You, to your agent

Edit the latest file.

curl -X POST https://api.sb/tutorloop.com/files/file_1/edit \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"instruction":"Example instruction"}'

import { $ } from 'startup-builder'

const file = await $.File.edit({ file: 'file_1', instruction: 'Example instruction' })

npx startup-builder do File.edit --json '{"file":"file_1","instruction":"Example instruction"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.File.edit({ file: 'file_1', instruction: 'Example instruction' })"
  }
}

Inputs

Input	Type	Required	Description
`file`	File	required	The source File.
`instruction`	`text`	required	What to change.
`references`	list of File		Further Files the edit follows.
`format`	`json`		Aspect ratio, resolution, duration and file type of the result.

Outputs

Output	Type	Required	Description
`file`	File	required	The new File, which records its source.

Effects

Emits File.edited.
Performed by the Content Lead.
Two-way: it runs at once, in the try, send and do modes.
Runs as a background Action and copies the result into Storage before done.
Never changes the source File.

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

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

Previous Page

File.generate

Next Page