Read the film
read_filmRead main.film, the document that is the project, or with path another film file of the project (a module it imports, such as brand.film; list_files lists them). Required nullable offset (1-indexed start line) and limit return a line window. Line numbers are a map; do not copy them into patch_film find. Use this before patch_film. Does not list uploaded assets or TypeScript components. When an effect in the film still waits for something (its person mask being made, a face, a photo), the answer ends with Effects waiting: what each one needs and the call that settles it, most often prepare_effect. When the film has events (an on a clip, a key's event, or one a component emits from its code with useCues().emit), the answer lists them under Events in film seconds, each with the at that keeps a sound clip on it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | The film file: null for main.film, or a module file name such as "brand.film" (letters, digits, - and _ before .film, no folders). list_files lists them. | |
| limit | Yes | Number of lines to return. Pass null to read through the cap. | |
| offset | Yes | 1-indexed start line. Pass null with limit to read from the start. | |
| projectId | Yes | The project this call runs on without changing the open project. null (or leaving it out) uses the open project. wait_for_jobs takes the projectId of the calls that started the jobs. |