File
Makes a new 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
Its Inputs, Outputs, Effects and guards quote the hub’s File.edit; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Media.
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.editedfires when it is done.do: Waits for the Action to finish and returns the record.
- Idempotency
Only with a key: the same
Idempotency-Keyand input return the first Action, and the same key with other input returns409.- Saved or shared
Runs as a background Action and copies the result into Storage before
done. Never changes the source File.- Emits
File.editedwith{ file }- Performed by
- 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.
Upscale the dashboard screenshot to 2K for the LinkedIn ad.{
"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.