Full reference

Workspace storage

Upload a task input, keep its storage key, and retrieve the result of a managed skill. Use object IDs for object administration and keys for task input and output.

Updated

Reviewed against Console v0.2.2. Available actions depend on project access and runtime configuration; check your installed CLI version for command differences.

Find storage in Console

Use Settings → Project → Storage for the selected project. CLI and runtime storage operations below can have different workspace/runtime scope; check their context before uploading or deleting an artifact. An object location is not automatically a publicly accessible URL.

Distinguish IDs from keys

A stored object has a record ID and a storage key. Sandbox tasks consume and return keys. Signed links and deletion operate on object IDs. Keep both when an operation returns them.

Inspect stored objects

bash
stimulir storage list --json
stimulir storage folders

Use the active workspace and filter by task ID when investigating one run. List responses are bounded; absence from a returned page is not proof that an object does not exist.

Upload an input

bash
stimulir storage upload input.json

Retain the returned key for the task. Check that the file is suitable for storage in this workspace before uploading it. Use Privacy where text needs de-identification.

Create a temporary download link

bash
stimulir storage link <object-id> --expires-in 900 --download

A signed link grants access until it expires. Share it only with the intended recipient and avoid putting it in public logs.

Retrieve a sandbox result

bash
stimulir storage get --key <output-key> --output result.json

The CLI resolves the key from the recent object listing. This lookup is bounded to 100 objects; if an older key is not found, locate its record in the Console or API instead of rerunning the task blindly.

Delete an object deliberately

stimulir storage delete <object-id> removes the stored file and its record. Confirm the owning workspace and dependent tasks first. Deleting a record is not a way to cancel a running task.

Command catalogue

Expand a command for its arguments. These commands follow the released CLI source; check stimulir --version and the command’s --help for your installation. Required flags are marked; some operations also validate combinations of inputs.

stimulir storage delete

Delete a stored object (removes the S3 file and its record).

object_id required
Positional argument. Object id to delete (S3 + row).
stimulir storage folders

List storage folders for the active workspace.

--json
Print raw JSON.
stimulir storage get

Resolve a storage KEY to a signed URL (or download it) — the loop-closer for a sandbox output_key, which is a key, not an object id.

--key required
Storage key (e.g. a sandbox run/sandbox pipe output_key).
--expires-in
Signed URL TTL in seconds.
--output, -o
Download the bytes to this file instead of printing the signed URL.
stimulir storage link

Mint a time-limited signed URL for a stored object.

object_id required
Positional argument. Object id (from storage list).
--expires-in
Signed URL TTL in seconds.
--download
Content-Disposition: attachment.
stimulir storage list

List stored objects for the active workspace.

--task-id
Filter to one dedicated-task run.
--json
Print raw JSON.
stimulir storage upload

Upload an input file into tenant storage; prints its storage key.

file required
Positional argument. Local file to upload.
--name
Storage filename (defaults to the file's name).

SDK method catalogue

Expand a client to inspect public methods and parameter names. Read each operation’s task guide before supplying a payload or starting work. The SDK returns platform responses; handle errors and inspect completion state before using a result.

client.storageStorageClient
upload(file, workspace_id, filename, content_type)
Upload an input into tenant storage and return its storage key.
list(workspace_id, task_id)
Returns the platform response; inspect its status and error detail.
folders(workspace_id)
Returns the platform response; inspect its status and error detail.
access_url(object_id, expires_in_seconds, download)
Returns the platform response; inspect its status and error detail.
delete(object_id)
Returns the platform response; inspect its status and error detail.
get_by_key(storage_key, workspace_id, expires_in_seconds, download)
Resolve a storage key to its object + a signed access URL.
read_by_key(storage_key, workspace_id)
Download the bytes behind a storage key (upload -> run -> read loop closer).