Read VFS.md
curl --request GET \
--url http://127.0.0.1:8765/v1/workspaces/{workspace_id}/vfs-md \
--header 'Authorization: Bearer <token>'import requests
url = "http://127.0.0.1:8765/v1/workspaces/{workspace_id}/vfs-md"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://127.0.0.1:8765/v1/workspaces/{workspace_id}/vfs-md', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));---
name: workspace-filesystem
description: The virtual filesystem layout of this workspace.
---
# Virtual Filesystem
You work in a terminal over a virtual filesystem. Read files with shell commands; access is checked for each operation.
| Path | Description |
| --- | --- |
| `/` | write |
| `/dev` | write |
## Supported Unix Commands for VFS
Unix commands work on each path as on a local filesystem, as far as the path supports them:
| Path | Supported |
| --- | --- |
| `/` | Almost all Unix commands. |
| `/dev` | Almost all Unix commands. |
## Limitations of Unix Commands for VFS
Where a path differs from a local filesystem:
| Path | Limitations |
| --- | --- |
| `/` | `grep -r`, `find` and `du` stop after 10000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused. |
| `/dev` | `grep -r`, `find` and `du` stop after 10000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused. |
Run `man <cmd>` or `<cmd> --help` for one command's usage.
Agent Instructions
Read VFS.md
GET
/
v1
/
workspaces
/
{workspace_id}
/
vfs-md
Read VFS.md
curl --request GET \
--url http://127.0.0.1:8765/v1/workspaces/{workspace_id}/vfs-md \
--header 'Authorization: Bearer <token>'import requests
url = "http://127.0.0.1:8765/v1/workspaces/{workspace_id}/vfs-md"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://127.0.0.1:8765/v1/workspaces/{workspace_id}/vfs-md', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));---
name: workspace-filesystem
description: The virtual filesystem layout of this workspace.
---
# Virtual Filesystem
You work in a terminal over a virtual filesystem. Read files with shell commands; access is checked for each operation.
| Path | Description |
| --- | --- |
| `/` | write |
| `/dev` | write |
## Supported Unix Commands for VFS
Unix commands work on each path as on a local filesystem, as far as the path supports them:
| Path | Supported |
| --- | --- |
| `/` | Almost all Unix commands. |
| `/dev` | Almost all Unix commands. |
## Limitations of Unix Commands for VFS
Where a path differs from a local filesystem:
| Path | Limitations |
| --- | --- |
| `/` | `grep -r`, `find` and `du` stop after 10000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused. |
| `/dev` | `grep -r`, `find` and `du` stop after 10000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused. |
Run `man <cmd>` or `<cmd> --help` for one command's usage.
Read VFS.md as Markdown for the selected session.
See error examples and recovery steps. The complete OpenAPI contract includes every response schema.
---
name: workspace-filesystem
description: The virtual filesystem layout of this workspace.
---
# Virtual Filesystem
You work in a terminal over a virtual filesystem. Read files with shell commands; access is checked for each operation.
| Path | Description |
| --- | --- |
| `/` | write |
| `/dev` | write |
## Supported Unix Commands for VFS
Unix commands work on each path as on a local filesystem, as far as the path supports them:
| Path | Supported |
| --- | --- |
| `/` | Almost all Unix commands. |
| `/dev` | Almost all Unix commands. |
## Limitations of Unix Commands for VFS
Where a path differs from a local filesystem:
| Path | Limitations |
| --- | --- |
| `/` | `grep -r`, `find` and `du` stop after 10000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused. |
| `/dev` | `grep -r`, `find` and `du` stop after 10000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused. |
Run `man <cmd>` or `<cmd> --help` for one command's usage.
Errors
Errors
| Status | Meaning |
|---|---|
400 | The request is malformed: the body is not JSON (invalid_json) or not a JSON object, a field is missing (missing_field), unknown (unknown_field) or has a wrong value (invalid_value), or the request is otherwise invalid (invalid_request). param names the field at fault. |
401 | The token is missing or wrong (unauthorized). |
404 | The workspace, session, job, file or route does not exist, or the caller may not see it (not_found). |
429 | Past a rate limit (rate_limited), or a new session past max_sessions (session_limit). |
Authorizations
Query Parameters
Response
200 - text/markdown
Generated VFS.md document.
The response is of type string.