Quickstart

Set the hosted API URL and your access token in the terminal that sends requests:

export MIRAGE_BASE_URL='https://api.strukto.ai'
export MIRAGE_AUTH_TOKEN='replace-with-your-token'

For another deployment, set MIRAGE_BASE_URL to its API URL and use its token. Create a workspace with an in-memory filesystem:

curl "$MIRAGE_BASE_URL/v1/workspaces" \
  -H "Authorization: Bearer $MIRAGE_AUTH_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"id":"demo","config":{"mounts":{"/":{"vfs":"ram","mode":"write"}}}}'

The response has status 201 and the workspace identifier demo. An identical retry returns the existing workspace with status 200. Supply either config or a saved template, never both. Run a shell command in that workspace:

curl "$MIRAGE_BASE_URL/v1/workspaces/demo/shell" \
  -H "Authorization: Bearer $MIRAGE_AUTH_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"command":"echo hello"}'

The response contains the command’s output and exit status:

{"kind":"io","exit_code":0,"stdout":"hello\n","stderr":"","refusal":null}

Use Create a workspace and Run a shell line for the complete request fields and responses. Browse the resource groups on the left, or use the endpoint search to find an operation by path, parameter or response field. For local daemon setup, see the HTTP server guide.

HTTP API

Resources