URL: /code/apps/media/edit · Id: `page:/code/apps/media/edit`

# File.edit

> Makes a new File from one you have, by instruction, such as upscaling or animating a still; the original stays.

POST https://api.sb/{your-domain}/files/{file}/edit

Makes a new [File](https://startupbuilder.dev/business/nouns/file) from one you have, by instruction, such as upscaling or animating a still; the original stays.

- **Action class:** None
- **Approval:** Runs on its own
- **Emits:** `File.edited`
- **Price:** Free

```text title="Run it · Ask"
Upscale the dashboard screenshot to 2K for the LinkedIn ad.
```

```ts title="Run it · SDK"
import { $ } from 'startup-builder'

const result = await $.try.File.edit({ file: 'https://api.sb/leaseline.app/files/file_Ds3hB8sC1n', instruction: 'Upscale to 2048 pixels wide; keep the text sharp.' })
```

```json title="Run it · Response"
{
  "api": "https://api.sb/leaseline.app",
  "file": {
    "$id": "https://api.sb/leaseline.app/files/file_Ue5pS2cL9q",
    "$type": "File",
    "contentType": "image/png",
    "name": "dashboard-2k.png"
  },
  "action": {
    "operation": "File.edit",
    "mode": "try",
    "status": "done"
  }
}
```

Its Inputs, Outputs, Effects and guards quote [the hub’s `File.edit`](https://startupbuilder.dev/business/nouns/file/edit); this page adds what each Venue honors, its limits and a worked call. It is one of the [Verbs](https://startupbuilder.dev/business/nouns/verb) of [Media](/code/apps/media#verbs).

## Inputs
| Name | Type | Meaning |
| --- | --- | --- |
| `file` | `File` | Required. The source File. |
| `instruction` | `text` | Required. What to change. |
| `references` | `File[]` | Further Files the edit follows. Optional. |
| `format` | `json` | Aspect ratio, resolution, duration and file type of the result. Optional. |

## Outputs
| Field | Type | What `null` means |
| --- | --- | --- |
| `file` | `File` | Never null: the new File, which records its source. |

## Effects
**Action class**

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

**Modes**

- `try`: Runs every check and returns the record as it would be; nothing is stored.
- `send`: Returns a pending Action at once; `File.edited` fires when it is done.
- `do`: Waits for the Action to finish and returns the record.

**Idempotency**

Only with a key: the same `Idempotency-Key` and input return the first Action, and the same key with other input returns `409`.

**Saved or shared**

Runs as a background Action and copies the result into Storage before `done`. Never changes the source File.

**Emits**

`File.edited` with `{ file }`

**Performed by**

[Content lead](https://startupbuilder.dev/agents/marketing/content-lead)

**Price**

Free on your own account: the platform charges nothing for the call.

## On each Venue
It acts on your own records and reaches no Venue, so every account answers the same way.

## What try does
Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

## Refuses when
The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

## When it waits
Runs as a background Action and copies the result into Storage before `done`. In `send` mode it returns the pending Action at once, and `File.edited` delivers the result.

## Example
In `send` mode the call returns its pending Action at once, and `File.edited` delivers the result.

**Ask**

```text
Upscale the dashboard screenshot to 2K for the LinkedIn ad.
```

**API**

```bash
curl -X POST "https://api.sb/leaseline.app/files/file_Ds3hB8sC1n/edit?mode=send" \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "instruction": "Upscale to 2048 pixels wide; keep the text sharp."
}'
```

**CLI**

```bash
npx startup-builder do File.edit --send --data '{
  "instruction": "Upscale to 2048 pixels wide; keep the text sharp."
}'
```

`--send` returns the pending Action at once.

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "mode": "send",
    "code": "return await $.File.edit({ instruction: 'Upscale to 2048 pixels wide; keep the text sharp.' })"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const result = await $.send.File.edit({
  file: 'https://api.sb/leaseline.app/files/file_Ds3hB8sC1n',
  instruction: 'Upscale to 2048 pixels wide; keep the text sharp.',
})
```


```json title="Response, in send mode"
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "File.edit",
    "status": "pending",
    "reason": "running"
  }
}
```

To retry, send the same `Idempotency-Key`: the retry returns the first answer for $0. A new key reads again.

## Used by
None.

## Related
[`Video.draft`](/code/apps/media/draft) · [`Video.finalize`](/code/apps/media/finalize) · [`File.generate`](/code/apps/media/generate) · [`Voice.clone`](/code/apps/media/clone) · [`Voice.retire`](/code/apps/media/retire)