Files

Read file

Read a file from the computer.

Zo Computer supports a wide range of file formats including text, word processing, spreadsheets, PDFs, ebooks, images, audio, and video. AI that can work with spreadsheets (.xlsx, .xls). AI that can work with Word documents (.docx, .doc). AI that can work with PDF files (.pdf). AI that can transcribe audio files (.mp3, .wav, .m4a). AI that can transcribe and convert video files (.mp4, .mov, .avi). AI that can work with ebooks (.epub). AI that can see and convert images (.png, .jpg, .gif).

Parameters#

target_filestringrequired

The absolute path of the file to read.

start_linenumberdefault: -1

The 1-indexed line number to start reading from (text files).

end_linenumberdefault: -1

The 1-indexed line number to end reading at, inclusive (text files).

read_entire_filebooleandefault: false

If true, read the entire text file.

pdf_epub_start_page_1_indexednumberdefault: -1

The 1-indexed start page for the PDF/EPUB read.

pdf_epub_end_page_1_indexed_inclusivenumberdefault: -1

The 1-indexed end page (inclusive) for the PDF/EPUB read.

pdf_epub_include_imagesbooleandefault: false

If true, include rendered page images. This is slower and should be used sparingly.

devicestringdefault: ""

Optional fleet device name or id. When set, reads the file from that running device's container instead of the host. The device must be started first. Requires the 'devices:manage' scope.

zappstringdefault: ""

Optional Zo App slug or id. When set, reads the file from that Zo App's sandbox instead of the host. Mutually exclusive with 'device'. Requires the 'apps:shell' scope.