Skip to main content
POST
Call page.read_file

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
path
string
required

The file's project-relative path exactly as page.list_files reported it (for example src/pages/index.astro). Never a leading slash, never ...

Required string length: 1 - 1024
site_id
string<uuid>

The site to act on, as a site UUID from page.list. On a site's own page, leave it out where this schema makes it optional: the call acts on the site open there, unless the member names another site. On any other screen (Analytics, the desk, Connections) no site is open, so pass it: call page.list with name set to the site the member named and pass the site_id it returns. When they named no site, call page.list without a name: pass the one site's id when the brand has one, and ask which site they mean when it has several. Never pass an id you composed, or one that names a board, thread or other object.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
start_line
integer

The first line to read (1-based). Leave it out to start at the top; when the result says has_more, call again from end_line + 1.

Required range: x >= 1
max_lines
integer

How many lines to read, at most 200. A long file is read in windows; never guess the part you have not read.

Required range: 1 <= x <= 200
workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
site_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
path
string
required
source_ref
string
required
kind
enum<string>
required
Available options:
text,
binary
size
integer
required
Required range: x >= 0
has_more
boolean
required
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.

content_type
string
content
string
start_line
integer
Required range: x >= 1
end_line
integer
Required range: x >= 0
total_lines
integer
Required range: x >= 0