ShellServerToolConfig Type | OpenRouter TypeScript SDK | OpenRouter

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Configuration for the openrouter:shell server tool

Example Usage

1 import { ShellServerToolConfig } from "@openrouter/sdk/models";
2 
3 let value: ShellServerToolConfig = {};

Field	Type	Required	Description	Example
`engine`	models.ShellServerToolEngine	➖	Which shell engine to use. “openrouter” runs commands server-side in the OpenRouter sandbox. “auto” (default) keeps the provider’s native hosted shell when available (OpenAI); on other providers the call is routed to the OpenRouter sandbox.	openrouter
`environment`	models.ShellServerToolEnvironment	➖	Server-side execution environment for the shell tool. Only container-backed environments are supported; “local” shells are not.	`{"type": "container_auto"}`
`sleepAfterSeconds`	number	➖	How long (in seconds) the container stays warm after its last command before sleeping, freeing its capacity slot. Idle-based: each command renews the timer. Defaults to 900 (15 minutes); capped at 2592000 (30 days).	900