File programs: edit, generate

Reference for File, one group of File programs.

File.editCopy Anchor Link

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

do: return await $.File.edit(input)

Emits File.edited.

Inputs

Returns

Refuses when

Example

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

File.generateCopy Anchor Link

Generate makes an image, video, speech or music File from a prompt and reference Files, and records how it was made. Verb page.

do: return await $.File.generate(input)

Emits File.generated.

Inputs

Returns

Refuses when

Example

{
  "name": "do",
  "arguments": {
    "code": "return await $.File.generate({ kind: 'image', prompt: 'Example prompt' })"
  }
}