Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tudoumono/Sherpa/llms.txt

Use this file to discover all available pages before exploring further.

Sherpa’s My Workspace (マイワークスペース) gives every user a private file area that sits completely outside the shared knowledge base. Files you upload there are grep-searchable only by you and can optionally be included in your chat answers alongside shared-KB results. No other user — including administrators — can see your workspace files through Sherpa’s search or citation features.

​
Purpose and privacy

Workspace files exist for personal reference material: working drafts, personal notes, local copybooks, or any file you need to query without adding it to the organisation-wide index.
Workspace files are never indexed in Elasticsearch or Neo4j. They do not appear in any other user’s search results, impact analyses, or citation footers. The only operation they support is per-user grep, triggered either from the Workspace screen or from the chat interface when the personal-file toggle is on.

​
Allowed file types

Only plain-text files are accepted. The supported extensions are: .txt · .md · .markdown · .csv · .tsv · .json · .yaml · .yml · .cbl · .cob · .cobol · .cpy · .copybook · .jcl · .sql · .py · .sh · .bat Binary files (Office documents, PDFs, images, compiled objects) cannot be uploaded. If you need Sherpa to produce an Office file and place it in your workspace, use the Codex authoring feature described below.

​
Size and expiry limits

SettingDefaultEnvironment variable
Maximum file size10 MB per fileSHERPA_WORKSPACE_MAX_BYTES
Time-to-live90 daysSHERPA_WORKSPACE_TTL_DAYS
Files expire automatically after the configured TTL. Expired files are removed from the catalogue and from disk during the background sweep that runs at startup and periodically thereafter. Set SHERPA_WORKSPACE_TTL_DAYS=0 to disable expiry entirely.

​
Uploading a file via the UI

1

Open the Workspace screen

Navigate to /ui/workspace.html. You must be logged in. The screen shows your existing files and an upload zone.
2

Select or drop a file

Click inside the upload zone to open a file picker, or drag and drop a file directly onto it. Only one file is uploaded per operation.
3

Wait for confirmation

Sherpa validates the file extension and size, then saves the file to your personal workspace directory. A confirmation message appears below the upload zone. The file immediately appears in your file list.
4

Verify the file

The file list shows each file’s name, size, and expiry date. You can use the search box on the Workspace screen to run a quick grep across your files and confirm the content is accessible.

​
Managing files via the API

# Upload a file
POST /workspace/files
Content-Type: multipart/form-data
(field: file)

# List your files
GET /workspace/files

# Delete a file
DELETE /workspace/files/{file_id}

# Search (grep) your files
GET /workspace/search?q=COPY+TAXCALC
All workspace endpoints operate on the currently authenticated user’s files only. There is no endpoint that allows one user to access another user’s workspace.

​
Using workspace files in chat

Enable the 個人ファイル参照 (Personal file reference) toggle near the chat input to include your workspace files in query results. The toggle is off by default. When the toggle is on:
  • Sherpa greps your workspace files alongside the shared knowledge base.
  • Any hits are shown in the answer as a separate 🗂 個人ファイル内ヒット (“personal file hits”) section, distinct from shared-KB citations.
  • The conversation is marked internally with a contains_personal_workspace flag.
Once a conversation has the contains_personal_workspace flag, it cannot be shared with other users through the normal share flow. The share button is disabled, and the API returns HTTP 409 if you attempt to create a share. If you need to share the non-personal portions of that conversation, use the sanitize=true option in the API — this creates a redacted snapshot that omits all personal turns. See Sharing for details.

​
Codex authoring into your workspace

When Codex is the active AI provider, you can ask it to generate Office files (.docx, .xlsx, .pptx) and write them directly into your workspace. Codex runs inside a sandboxed environment that has write access only to your personal authoring area — it cannot write to the shared knowledge base or any other user’s workspace. Generated files are moved from the Codex authoring sandbox to your workspace/files/ directory and registered in the workspace catalogue automatically. They then appear in your file list, respect the same TTL rules as uploaded files, and can be downloaded from the Workspace screen.

Build docs developers (and LLMs) love

Get started for freeTalk to us