Component schema

Agent0SandboxProfile

allOf1 direct reference

Definition

The resource source for an Agent0 sandbox. type is the discriminator: default carries no id and may carry the deployment resources resolved for a specific thread, custom carries all four resource fields and no id, and catalog carries an id that the control plane resolves to its resource snapshot. For a catalog profile, resource values sent by a client are ignored and replaced with the current catalog values.

The resource fields are a snapshot, not a reference. Whatever selects a profile stores the whole object, so a thread keeps creating the sandbox it was created with even after the catalog entry behind it changes.

type is temporarily optional for migration. A profile that omits it must carry id and is interpreted as catalog. New clients should always send type.

allOfAll schemas combined2

The value must satisfy every schema below.

01Agent0SandboxResources

The resource shape one Agent0 sandbox is created with. Omitted fields fall back to the agents deployment's own configured defaults.

02object

Used by 1

These schemas and endpoints reference this type directly.

SchemaAgenticWorkflowSandbox

json

OpenAPI source{
  "description": "The resource source for an Agent0 sandbox. `type` is the discriminator: `default` carries no\nid and may carry the deployment resources resolved for a specific thread, `custom` carries all\nfour resource fields and no id, and `catalog` carries an id that the control plane resolves to\nits resource snapshot. For a catalog profile, resource values sent by a client are ignored and\nreplaced with the current catalog values.\n\nThe resource fields are a snapshot, not a reference. Whatever selects a profile stores the\nwhole object, so a thread keeps creating the sandbox it was created with even after the catalog\nentry behind it changes.\n\n`type` is temporarily optional for migration. A profile that omits it must carry `id` and is\ninterpreted as `catalog`. New clients should always send `type`.\n",
  "allOf": [
    {
      "$ref": "#/components/schemas/Agent0SandboxResources"
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/components/schemas/Agent0SandboxProfileType"
        },
        "id": {
          "description": "The catalog profile to resolve. Only valid when `type` is `catalog`.",
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "displayName": {
          "description": "Human-readable catalog profile name. Filled by the control plane on write.",
          "type": "string"
        },
        "isWarmPooled": {
          "description": "Whether a sandbox on this catalog profile is normally served from the deployment's\nwarm pool and so starts without waiting for one to be provisioned. This is a catalog-only\nhint, not a promise. The field is returned by `GET /api/agent0/sandbox-profiles`, omitted\nfrom stored snapshots, and ignored on writes.\n",
          "type": "boolean"
        }
      }
    }
  ]
}