Skip to main content
This is preview documentation. The official release is not yet available.
If you have not connected a Hosted Agent yet, follow Connect a Hosted Agent to bring the execution host online and create an Agent. Use this page to adjust configuration after connection, and Runtime Host setup and operations for installation and ongoing maintenance. Before changing a setting, identify the scope it should affect. Host connection settings determine which Service the host connects to, which providers it exposes, and how many executions it allows concurrently. A Runtime Profile stores a provider’s runtime parameters, while an Agent adds its own instructions and model overrides. Keeping settings at the appropriate scope lets several Agents share an execution environment while retaining their individual behavior.

Connection settings

This exposes the selected providers. Their CLIs must already be installed, authenticated and executable. The default file is ~/.agentscope/runtime-host/config.json. Its controlPlane, tenant, namespace, pool, capacity, workspaceRoot, stateRoot and providers fields describe the connection. credential is private identity material. Check active work before changing a running Host, then restart and probe again.

Agent versus Profile

Agent system defines responsibilities and model provides an optional override. A nonempty Agent model takes precedence over Profile model. When both are empty, the provider uses its own default. runtimeProfileId selects provider configuration; runtimePoolId selects the Host pool. Agent authors select a discovered Runtime through runtime-options; administrators maintain Profiles and pools. Raising Host capacity does not increase model quota or remove Agent/task policy limits.

Agent and runtime configuration APIs

Use a platform account Bearer token authorized for the target namespace. See connect and create an Agent for a complete creation request. Creation requires runtimeProfileId and runtimePoolId in binding.configuration, in the same scope, with optional executionOverrides. The portable definition uses the Managed format: commonly name, system, model, tools, mcpServers, skills, workspaceId, and workspaceBinding. Provider capabilities determine how these fields take effect. Read the complete definition before updating it; do not assume PATCH preserves every omitted field as a shallow merge.

Hosted settings fields

providerConfiguration is an object and customArgs is an argv string array. Provider validation rejects invalid or reserved options. Prefer per-Agent overrides for individual preferences instead of changing a shared Profile. This example updates only concurrency. AGENT_ID is an existing Agent UUID; SERVICE_URL and TOKEN configure management access:
On a version conflict, read the current settings, merge your changes, and retry.

Manage shared Profiles and Pools

GET /api/v1/runtime-profiles and /runtime-pools accept tenant and namespace and return items. Read individual resources through /runtime-profiles/{name} or /runtime-pools/{name}, returning profile or pool. For PUT, the path name selects the resource. Submit the complete desired configuration and retain returned UUIDs for Agent bindings. See Runtime Host APIs for enrollment, capacity, and pausing new work.

Provider parameters

These fields belong to Runtime Profile configuration, not to connect and not to a universal provider schema. Model identifiers, reasoning levels and account availability depend on the installed provider. Saving a Profile does not install models, authenticate accounts or grant external permissions.

Definition conflicts

Host translates portable instructions, skills and supported MCP/tool definitions into provider configuration. Unsupported requested capabilities fail before execution. See the provider matrix. Custom arguments are argv entries. Reserved arguments controlling workspace, model, output protocol, MCP and permissions cannot be freely overridden. Configure Codex native tools through Profile sandbox/approval settings; Managed built-in tool policies do not transfer to it.

Runtime types

Install and authenticate the provider before connecting Host. These are Service adapters; provider binaries are not bundled in the Service CLI release.

Portable definition mapping

Support indicates an implemented adapter path; installed CLI version and account capabilities still matter. Native Subagent mapping requires Codex 0.153.4+ or Qoder 1.0.37+ and currently requires shared workspaces. Codex mapping cannot enforce Subagent tools or maxIters. Qoder tool names must map to supported native tools. Codex, Qoder and QwenPaw provide control-plane tool approval integration. Claude Code uses its CLI permission configuration; this does not promise the same Inbox approval flow. OpenClaw uses the task CLI through Shell for collaboration because its adapter does not inject MCP.

Read capabilities reported by current Hosts

The tables explain mappings; actual availability comes from Host reports. Query with a platform account Bearer token:
Select an entry in runtimes. Each entry provides provider, version, runtimeProfileId, runtimePoolId, hostCount, and capabilities. The descriptor contains instructions, workspace, skills, subagents, tools, shell, mcp, model, customArgs, approval, and resume. resume is a boolean; other capability entries use supported, mode, and target to describe support and its mapping. GET /api/v1/runtime-hosts?tenant=...&namespace=... returns per-Host provider versions/descriptors in items[].capabilities. Put the selected profile/pool UUIDs in the Agent binding. Update per-Agent provider options through /api/v1/agents/{agentId}/hosted-settings; see configuration for fields. Provider resume describes native runtime recovery, which does not automatically provide a public Turn resume command. Applications should read Session and Turn capabilities and display commands only when available_commands includes them.