`readStudioAppFile`

Read Studio App File

readStudioAppFile: read one file from a Studio app and get its CONTENT (plus mimeType): the canonical way to read a page, a stylesheet or a script, the verb every other file tool points to.

read

Arguments

appIdstringrequiredThe Studio app ID
endLineintegeroptionalLast line to return, 1-indexed and INCLUSIVE. Omit to read to the end of the file.
lengthintegeroptionalAlias of maxBytes. maxBytes wins if both are sent.
maxBytesintegeroptionalCanonical. Cap on how many UTF-8 bytes of content to return, starting at offset. Omit to return the whole file (up to 1048576 bytes). Use with offset to page through a file too large for one response. `length` is accepted as an alias.
offsetintegeroptionalCanonical. Byte offset to start reading from (default 0). Pass the previous response's nextOffset to read the next window. `start` is accepted as an alias.
pathstringrequiredThe file path within the app
startintegeroptionalAlias of offset. offset wins if both are sent.
startLineintegeroptionalFirst line to return, 1-indexed. Clamped to the file. Omit with endLine to read from line 1.

Returns

The registry does not declare a return shape.

Declared limits

endLine: greater than 0
endLine: maximum 9007199254740991
length: greater than 0
length: maximum 1048576
maxBytes: greater than 0
maxBytes: maximum 1048576
offset: minimum 0
offset: maximum 9007199254740991
start: minimum 0
start: maximum 9007199254740991
startLine: greater than 0
startLine: maximum 9007199254740991

Ask for it

The Cloud routes these requests to this verb.

read this file
open guide-august30.html
show me index.html in X
read the page so you can make one like it
get the contents of style.css
read lines 400-460 of app.js
what's in style.css of my X app
readStudioAppFile

Pair it with

The verbs that finish the job.