Component schema

AgenticWorkflowSandbox

object1 direct reference

Definition

The sandbox an automation's runs execute in: what it may reach, and what it is built from.

Controls outbound network access for the sandbox running the automation.

"no_network""trusted_only""full"

Sandbox resources for an automation run's thread. A default profile uses the agents deployment's configured resources, custom carries all four resource fields, and catalog names an entry from GET /api/agent0/sandbox-profiles. A catalog selection is resolved to its resource snapshot on write; custom resources are stored unchanged. Omitted, this behaves like {"type":"default"}.

This is the default for the threads this automation starts — a sandbox profile is a thread invariant, so editing it leaves running threads on the profile they were created with and applies only to new ones.

string

Optional sandbox preparation: a shell script run once in a claimed sandbox before the worker attaches OpenCode, e.g. to install a CLI the run's prompt or tool calls need. Executed via the sandbox's exec facility; absent or empty runs nothing. A failed setup script degrades (recorded on telemetry) rather than failing the claim. Only takes effect when featureFlags.enableAutomationSetupScripts is enabled.

object

Environment variables passed to the setup script's own process only, and surfaced in the UI as "Setup variables". Not secret storage: the values live in this definition as plain text, so every retained version keeps them, a duplicate or a share carries them, and getAutomation returns them verbatim to the agent. Use the deployment's Agent0 environment-variable settings for a credential. Only key names enter the setup cache hash, never values — but declaring any key makes the setup source permanently ineligible for a shared warm standby, because the seeding path runs org-blind with no env injected. The values do not reach the agent's own shell; a setup script that wants to hand one on must export it to $DASH0_AGENT_ENV, which is visible to the agent and the model.

Used by 1

These schemas and endpoints reference this type directly.

SchemaAgenticWorkflowSpec

json

OpenAPI source{
  "description": "The sandbox an automation's runs execute in: what it may reach, and what it is built from.\n",
  "properties": {
    "networkLevel": {
      "$ref": "#/components/schemas/NetworkLevel",
      "description": "Controls outbound network access for the sandbox running the automation.\n"
    },
    "profile": {
      "$ref": "#/components/schemas/Agent0SandboxProfile",
      "description": "Sandbox resources for an automation run's thread. A `default` profile uses the agents\ndeployment's configured resources, `custom` carries all four resource fields, and\n`catalog` names an entry from `GET /api/agent0/sandbox-profiles`. A catalog selection is\nresolved to its resource snapshot on write; custom resources are stored unchanged.\nOmitted, this behaves like `{\"type\":\"default\"}`.\n\nThis is the default for the *threads this automation starts* — a sandbox profile is a\nthread invariant, so editing it leaves running threads on the profile they were created\nwith and applies only to new ones.\n"
    },
    "setupScript": {
      "description": "Optional sandbox preparation: a shell script run once in a claimed sandbox\nbefore the worker attaches OpenCode, e.g. to install a CLI the run's prompt or tool calls\nneed. Executed via the sandbox's exec facility; absent or empty runs nothing. A failed\nsetup script degrades (recorded on telemetry) rather than failing the claim. Only takes\neffect when `featureFlags.enableAutomationSetupScripts` is enabled.\n",
      "type": "string"
    },
    "envVars": {
      "description": "Environment variables passed to the setup script's own process only, and surfaced in the\nUI as \"Setup variables\". Not secret storage: the values live in this definition as plain\ntext, so every retained version keeps them, a duplicate or a share carries them, and\ngetAutomation returns them verbatim to the agent. Use the deployment's Agent0\nenvironment-variable settings for a credential. Only key names enter the setup cache\nhash, never values — but declaring any key makes the setup source permanently ineligible\nfor a shared warm standby, because the seeding path runs org-blind with no env injected.\nThe values do not reach the agent's own shell; a setup script that wants to hand one on\nmust export it to $DASH0_AGENT_ENV, which is visible to the agent and the model.\n",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "networkLevel"
  ]
}