> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Find endpoints by resource, path, parameter, or response field.

Browse the resource groups in the sidebar, or search the operations below.
Each endpoint includes request fields, response schemas, and examples from the
[OpenAPI contract](https://github.com/strukto-ai/mirage/blob/main/docs/openapi.yaml).

GET

List workspaces
/v1/workspaces
Workspaces / Lifecycle

[Open](https://docs.mirage.strukto.ai/api/operations/workspaces/list-workspaces.md)

POST

Create workspace
/v1/workspaces
Workspaces / Lifecycle

[Open](https://docs.mirage.strukto.ai/api/operations/workspaces/create-workspace.md)

GET

Get workspace
/v1/workspaces/\{workspace\_id}
Workspaces / Lifecycle

[Open](https://docs.mirage.strukto.ai/api/operations/workspaces/get-workspace.md)

DELETE

Delete workspace
/v1/workspaces/\{workspace\_id}
Workspaces / Lifecycle

[Open](https://docs.mirage.strukto.ai/api/operations/workspaces/delete-workspace.md)

POST

Cancel all commands
/v1/workspaces/\{workspace\_id}/cancel
Workspaces / Lifecycle

[Open](https://docs.mirage.strukto.ai/api/operations/workspaces/cancel-all-commands.md)

POST

Stop all background jobs
/v1/workspaces/\{workspace\_id}/kill
Workspaces / Lifecycle

[Open](https://docs.mirage.strukto.ai/api/operations/workspaces/stop-all-background-jobs.md)

GET

List workspace logs
/v1/workspaces/\{workspace\_id}/logs
Workspaces / Lifecycle

[Open](https://docs.mirage.strukto.ai/api/operations/workspaces/list-workspace-logs.md)

POST

Start workspace
/v1/workspaces/\{workspace\_id}/start
Workspaces / Lifecycle

[Open](https://docs.mirage.strukto.ai/api/operations/workspaces/start-workspace.md)

POST

Stop workspace
/v1/workspaces/\{workspace\_id}/stop
Workspaces / Lifecycle

[Open](https://docs.mirage.strukto.ai/api/operations/workspaces/stop-workspace.md)

POST

Run shell command
/v1/workspaces/\{workspace\_id}/shell
Workspaces / Shell

[Open](https://docs.mirage.strukto.ai/api/operations/shell/run-shell-command.md)

POST

Append to file
/v1/workspaces/\{workspace\_id}/vfs/append
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/append-to-file.md)

POST

Create empty file
/v1/workspaces/\{workspace\_id}/vfs/create
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/create-empty-file.md)

POST

Check path exists
/v1/workspaces/\{workspace\_id}/vfs/exists
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/check-path-exists.md)

POST

Get extended attribute
/v1/workspaces/\{workspace\_id}/vfs/getxattr
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/get-extended-attribute.md)

POST

Check path is directory
/v1/workspaces/\{workspace\_id}/vfs/is\_dir
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/check-path-is-directory.md)

POST

Check path is file
/v1/workspaces/\{workspace\_id}/vfs/is\_file
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/check-path-is-file.md)

POST

List file names
/v1/workspaces/\{workspace\_id}/vfs/list\_files
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/list-file-names.md)

POST

List extended attributes
/v1/workspaces/\{workspace\_id}/vfs/listxattr
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/list-extended-attributes.md)

POST

Create directory
/v1/workspaces/\{workspace\_id}/vfs/mkdir
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/create-directory.md)

POST

Write at file offset
/v1/workspaces/\{workspace\_id}/vfs/pwrite
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/write-at-file-offset.md)

POST

Read file
/v1/workspaces/\{workspace\_id}/vfs/read
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/read-file.md)

POST

List directory entries
/v1/workspaces/\{workspace\_id}/vfs/readdir
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/list-directory-entries.md)

POST

Read symbolic link
/v1/workspaces/\{workspace\_id}/vfs/readlink
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/read-symbolic-link.md)

POST

Remove extended attribute
/v1/workspaces/\{workspace\_id}/vfs/removexattr
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/remove-extended-attribute.md)

POST

Rename path
/v1/workspaces/\{workspace\_id}/vfs/rename
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/rename-path.md)

POST

Delete empty directory
/v1/workspaces/\{workspace\_id}/vfs/rmdir
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/delete-empty-directory.md)

POST

Update path attributes
/v1/workspaces/\{workspace\_id}/vfs/setattr
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/update-path-attributes.md)

POST

Set extended attribute
/v1/workspaces/\{workspace\_id}/vfs/setxattr
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/set-extended-attribute.md)

POST

Get path metadata
/v1/workspaces/\{workspace\_id}/vfs/stat
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/get-path-metadata.md)

POST

Create symbolic link
/v1/workspaces/\{workspace\_id}/vfs/symlink
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/create-symbolic-link.md)

POST

Resize file
/v1/workspaces/\{workspace\_id}/vfs/truncate
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/resize-file.md)

POST

Delete file
/v1/workspaces/\{workspace\_id}/vfs/unlink
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/delete-file.md)

POST

Write file
/v1/workspaces/\{workspace\_id}/vfs/write
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/write-file.md)

POST

Call VFS function
/v1/workspaces/\{workspace\_id}/vfs/\{name}
Workspaces / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/vfs/call-vfs-function.md)

GET

Read SKILL.md
/v1/workspaces/\{workspace\_id}/skill-md
Workspaces / Agent Instructions

[Open](https://docs.mirage.strukto.ai/api/operations/documents/read-skillmd.md)

PUT

Write SKILL.md
/v1/workspaces/\{workspace\_id}/skill-md
Workspaces / Agent Instructions

[Open](https://docs.mirage.strukto.ai/api/operations/documents/write-skillmd.md)

GET

Read VFS.md
/v1/workspaces/\{workspace\_id}/vfs-md
Workspaces / Agent Instructions

[Open](https://docs.mirage.strukto.ai/api/operations/documents/read-vfsmd.md)

PUT

Write VFS.md
/v1/workspaces/\{workspace\_id}/vfs-md
Workspaces / Agent Instructions

[Open](https://docs.mirage.strukto.ai/api/operations/documents/write-vfsmd.md)

GET

List VFS
/v1/vfs
Configuration / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/saved-vfs/list-vfs.md)

POST

Create VFS
/v1/vfs
Configuration / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/saved-vfs/create-vfs.md)

GET

List VFS types
/v1/vfs/types
Configuration / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/saved-vfs/list-vfs-types.md)

GET

Get VFS
/v1/vfs/\{ref}
Configuration / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/saved-vfs/get-vfs.md)

PUT

Update VFS
/v1/vfs/\{ref}
Configuration / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/saved-vfs/update-vfs.md)

DELETE

Delete VFS
/v1/vfs/\{ref}
Configuration / VFS

[Open](https://docs.mirage.strukto.ai/api/operations/saved-vfs/delete-vfs.md)

GET

List CLIs
/v1/clis
Configuration / CLI

[Open](https://docs.mirage.strukto.ai/api/operations/saved-clis/list-clis.md)

POST

Create CLI
/v1/clis
Configuration / CLI

[Open](https://docs.mirage.strukto.ai/api/operations/saved-clis/create-cli.md)

GET

List CLI types
/v1/clis/types
Configuration / CLI

[Open](https://docs.mirage.strukto.ai/api/operations/saved-clis/list-cli-types.md)

GET

Get CLI
/v1/clis/\{ref}
Configuration / CLI

[Open](https://docs.mirage.strukto.ai/api/operations/saved-clis/get-cli.md)

PUT

Update CLI
/v1/clis/\{ref}
Configuration / CLI

[Open](https://docs.mirage.strukto.ai/api/operations/saved-clis/update-cli.md)

DELETE

Delete CLI
/v1/clis/\{ref}
Configuration / CLI

[Open](https://docs.mirage.strukto.ai/api/operations/saved-clis/delete-cli.md)

GET

List machines
/v1/machines
Configuration / Machine

[Open](https://docs.mirage.strukto.ai/api/operations/saved-machines/list-machines.md)

POST

Create machine
/v1/machines
Configuration / Machine

[Open](https://docs.mirage.strukto.ai/api/operations/saved-machines/create-machine.md)

GET

List machine types
/v1/machines/types
Configuration / Machine

[Open](https://docs.mirage.strukto.ai/api/operations/saved-machines/list-machine-types.md)

GET

Get machine
/v1/machines/\{ref}
Configuration / Machine

[Open](https://docs.mirage.strukto.ai/api/operations/saved-machines/get-machine.md)

PUT

Update machine
/v1/machines/\{ref}
Configuration / Machine

[Open](https://docs.mirage.strukto.ai/api/operations/saved-machines/update-machine.md)

DELETE

Delete machine
/v1/machines/\{ref}
Configuration / Machine

[Open](https://docs.mirage.strukto.ai/api/operations/saved-machines/delete-machine.md)

GET

List policies
/v1/policies
Configuration / Policies

[Open](https://docs.mirage.strukto.ai/api/operations/policies/list-policies.md)

POST

Create policy
/v1/policies
Configuration / Policies

[Open](https://docs.mirage.strukto.ai/api/operations/policies/create-policy.md)

GET

Get policy
/v1/policies/\{ref}
Configuration / Policies

[Open](https://docs.mirage.strukto.ai/api/operations/policies/get-policy.md)

PUT

Update policy
/v1/policies/\{ref}
Configuration / Policies

[Open](https://docs.mirage.strukto.ai/api/operations/policies/update-policy.md)

DELETE

Delete policy
/v1/policies/\{ref}
Configuration / Policies

[Open](https://docs.mirage.strukto.ai/api/operations/policies/delete-policy.md)

GET

List asks
/v1/workspaces/\{workspace\_id}/asks
Workspaces / Approval requests

[Open](https://docs.mirage.strukto.ai/api/operations/asks/list-asks.md)

POST

Respond to ask
/v1/workspaces/\{workspace\_id}/asks/\{ask\_id}
Workspaces / Approval requests

[Open](https://docs.mirage.strukto.ai/api/operations/asks/respond-to-ask.md)

GET

List commands
/v1/workspaces/\{workspace\_id}/lines
Workspaces / Commands

[Open](https://docs.mirage.strukto.ai/api/operations/lines/list-commands.md)

GET

Get command
/v1/workspaces/\{workspace\_id}/lines/\{line\_id}
Workspaces / Commands

[Open](https://docs.mirage.strukto.ai/api/operations/lines/get-command.md)

POST

Write stdin
/v1/workspaces/\{workspace\_id}/lines/\{line\_id}/stdin
Workspaces / Commands

[Open](https://docs.mirage.strukto.ai/api/operations/lines/write-stdin.md)

DELETE

Close stdin
/v1/workspaces/\{workspace\_id}/lines/\{line\_id}/stdin
Workspaces / Commands

[Open](https://docs.mirage.strukto.ai/api/operations/lines/close-stdin.md)

GET

List jobs
/v1/workspaces/\{workspace\_id}/jobs
Workspaces / Jobs

[Open](https://docs.mirage.strukto.ai/api/operations/jobs/list-jobs.md)

GET

Get job
/v1/workspaces/\{workspace\_id}/jobs/\{job\_id}
Workspaces / Jobs

[Open](https://docs.mirage.strukto.ai/api/operations/jobs/get-job.md)

GET

List processes
/v1/workspaces/\{workspace\_id}/processes
Workspaces / Processes

[Open](https://docs.mirage.strukto.ai/api/operations/processes/list-processes.md)

GET

Get process
/v1/workspaces/\{workspace\_id}/processes/\{pid}
Workspaces / Processes

[Open](https://docs.mirage.strukto.ai/api/operations/processes/get-process.md)

GET

List machines
/v1/workspaces/\{workspace\_id}/machines
Workspaces / Machines

[Open](https://docs.mirage.strukto.ai/api/operations/machines/list-machines.md)

GET

Get machine
/v1/workspaces/\{workspace\_id}/machines/\{machine}
Workspaces / Machines

[Open](https://docs.mirage.strukto.ai/api/operations/machines/get-machine.md)

GET

Check health
/v1/health
Server / Service

[Open](https://docs.mirage.strukto.ai/api/operations/service/check-health.md)

GET

Check readiness
/v1/daemon/ready
Server / Daemon

[Open](https://docs.mirage.strukto.ai/api/operations/daemon/check-readiness.md)

POST

Shut down server
/v1/daemon/shutdown
Server / Daemon

[Open](https://docs.mirage.strukto.ai/api/operations/daemon/shut-down-server.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.