50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
# `GET /vfs/{*path}`
|
|
|
|
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
|
|
|
Get a virtual filesystem file
|
|
|
|
Returns a file the model produced in the `javascript_execute` sandbox
|
|
(virtual filesystem), for the authenticated user's selected company.
|
|
|
|
Embed the returned URL in chat markdown to display a generated image:
|
|
``.
|
|
|
|
Images are returned as a 250x250 aspect-preserving preview unless requested with
|
|
`download=1` or `raw=1`.
|
|
Browser-compatible files (HTML, CSS, JS, JSON, PDF, text, images, media) are served
|
|
inline so they open directly in the browser; other files are sent as downloads.
|
|
|
|
|
|
## Path parameters
|
|
|
|
| Param | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `path` | yes | string | VFS file path (e.g. `example.png`, `labels/a.png`) |
|
|
|
|
## Query parameters
|
|
|
|
| Param | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `download` | no | boolean | Force file download with Content-Disposition: attachment.
|
|
|
|
|
| `raw` | no | boolean | Return original unmodified image inline without generating a preview thumbnail.
|
|
|
|
|
|
|
## Response `200`
|
|
|
|
File bytes
|
|
|
|
## Errors
|
|
|
|
| Status | Description |
|
|
|--------|-------------|
|
|
| 400 | Invalid path, or no company selected — `{"error":"…"}` |
|
|
| 401 | Unauthorized — `{"error":"…"}` |
|
|
| 403 | Not authorized — `{"error":"…"}` |
|
|
| 404 | File not found — `{"error":"…"}` |
|
|
|
|
---
|
|
|
|
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|