sandboxes

Read a file

Changed on

Downloads the contents of a file from a session's filesystem. The file content is returned as a binary stream with appropriate Content-Disposition headers for file download.

post/v2/sandboxes/sessions/{sessionId}/fs/read

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v2/sandboxes/sessions/{sessionId}/fs/read
  • Auth: HTTP bearer

Path parameters

sessionIdstring required

The unique identifier of the session to read the file from.

Example:sbx_abc123

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

cwdstring

The base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory.

pathstring required

The path of the file to read. Can be absolute or relative to the working directory.

Example request

{
  "cwd": "/home/vercel-sandbox",
  "path": "dist/agent-output.md"
}

Changes