Share feedback
Answers are generated based on the documentation.

Experimental

Schema

CreateSandboxRequest

Type: object

CreateSandboxRequest validates typed composition intent before replay and persists accepted guarantees, distinct enough from legacy create that old servers cannot silently drop it. display_name and display_name_prefix are mutually exclusive At most one of image, imageRef is set.
All constraints apply
agent

Type: string

agent names an optional agent profile; unsupported profiles fail explicitly.
All schema constraints and annotations
{
  "description": "agent names an optional agent profile; unsupported profiles fail explicitly.",
  "type": "string"
}
displayName

Type: string

(OPTIONAL) display_name is a scoped label; the backend assigns the immutable resource ID.
All schema constraints and annotations
{
  "description": "(OPTIONAL) display_name is a scoped label; the backend assigns the immutable resource ID.",
  "maxLength": 64,
  "pattern": "^[a-zA-Z0-9_-]*$",
  "type": "string"
}
displayNamePrefix

Type: string

(OPTIONAL) display_name_prefix requests a generated label and excludes display_name.
All schema constraints and annotations
{
  "description": "(OPTIONAL) display_name_prefix requests a generated label and excludes display_name.",
  "type": "string"
}
environment

Type: object

environment is non-secret environment metadata.
All schema constraints and annotations
{
  "additionalProperties": {
    "title": "value",
    "type": "string"
  },
  "description": "environment is non-secret environment metadata.",
  "type": "object"
}
features

Schema: FeatureOptions

features carries typed inputs validated before admission can have effects.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/FeatureOptions",
  "description": "features carries typed inputs validated before admission can have effects."
}
kits

Type: array

kits are the kit inputs to apply before readiness, in composition order.
Array item

Schema: KitInput

All schema constraints and annotations
{
  "$ref": "#/components/schemas/KitInput"
}
All schema constraints and annotations
{
  "description": "kits are the kit inputs to apply before readiness, in composition order.",
  "items": {
    "$ref": "#/components/schemas/KitInput"
  },
  "type": "array"
}
labels

Type: object

labels are non-secret caller-assigned key/value metadata recorded at admission. This contract has no verb that changes labels afterwards.
All schema constraints and annotations
{
  "additionalProperties": {
    "description": "",
    "title": "value",
    "type": "string"
  },
  "description": "labels are non-secret caller-assigned key/value metadata recorded at admission.\nThis contract has no verb that changes labels afterwards.",
  "maxProperties": 64,
  "type": "object"
}
mcp

Schema: McpCreateSpec

mcp requests an MCP gateway wired before the workload starts.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/McpCreateSpec",
  "description": "mcp requests an MCP gateway wired before the workload starts."
}
networkPolicies

Type: array

network_policies are inline policies materialized in governance and enforced before the first guest process. Omission or an empty list requests no inline policies; unsupported policies fail before create effects.
Array item

Schema: NetworkPolicy

All schema constraints and annotations
{
  "$ref": "#/components/schemas/NetworkPolicy"
}
All schema constraints and annotations
{
  "description": "network_policies are inline policies materialized in governance and enforced before the first guest process.\nOmission or an empty list requests no inline policies; unsupported policies fail before create effects.",
  "items": {
    "$ref": "#/components/schemas/NetworkPolicy"
  },
  "type": "array"
}
platform

Schema: Platform

platform selects an exact supported, image-compatible tuple when present. explicit platform requires OS and architecture
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Platform",
  "description": "platform selects an exact supported, image-compatible tuple when present.\nexplicit platform requires OS and architecture"
}
policyIds

Type: array

policy_ids names existing governance policies, never raw policy content.
Array item

Type: string

All schema constraints and annotations
{
  "minLength": 1,
  "type": "string"
}
All schema constraints and annotations
{
  "description": "policy_ids names existing governance policies, never raw policy content.",
  "items": {
    "minLength": 1,
    "type": "string"
  },
  "type": "array"
}
pullPolicy

Type: string

pull_policy retains shared image-pull semantics and explicit support errors.
All schema constraints and annotations
{
  "description": "pull_policy retains shared image-pull semantics and explicit support errors.",
  "enum": [
    "unspecified",
    "always"
  ],
  "title": "CreateSandboxRequestPullPolicy",
  "type": "string"
}
resources

Schema: Resources

resources requests CPU and memory within the selected placement's limits.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Resources",
  "description": "resources requests CPU and memory within the selected placement's limits."
}
startupExecution

Schema: StartupExecution

startup_execution is ordinary create input and persists for the sandbox lifetime.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/StartupExecution",
  "description": "startup_execution is ordinary create input and persists for\nthe sandbox lifetime."
}
All schema constraints and annotations
{
  "properties": {
    "agent": {
      "description": "agent names an optional agent profile; unsupported profiles fail explicitly.",
      "type": "string"
    },
    "displayName": {
      "description": "(OPTIONAL) display_name is a scoped label; the backend assigns the immutable resource ID.",
      "maxLength": 64,
      "pattern": "^[a-zA-Z0-9_-]*$",
      "type": "string"
    },
    "displayNamePrefix": {
      "description": "(OPTIONAL) display_name_prefix requests a generated label and excludes display_name.",
      "type": "string"
    },
    "environment": {
      "additionalProperties": {
        "title": "value",
        "type": "string"
      },
      "description": "environment is non-secret environment metadata.",
      "type": "object"
    },
    "features": {
      "$ref": "#/components/schemas/FeatureOptions",
      "description": "features carries typed inputs validated before admission can have effects."
    },
    "kits": {
      "description": "kits are the kit inputs to apply before readiness, in composition order.",
      "items": {
        "$ref": "#/components/schemas/KitInput"
      },
      "type": "array"
    },
    "labels": {
      "additionalProperties": {
        "description": "",
        "title": "value",
        "type": "string"
      },
      "description": "labels are non-secret caller-assigned key/value metadata recorded at admission.\nThis contract has no verb that changes labels afterwards.",
      "maxProperties": 64,
      "type": "object"
    },
    "mcp": {
      "$ref": "#/components/schemas/McpCreateSpec",
      "description": "mcp requests an MCP gateway wired before the workload starts."
    },
    "networkPolicies": {
      "description": "network_policies are inline policies materialized in governance and enforced before the first guest process.\nOmission or an empty list requests no inline policies; unsupported policies fail before create effects.",
      "items": {
        "$ref": "#/components/schemas/NetworkPolicy"
      },
      "type": "array"
    },
    "platform": {
      "$ref": "#/components/schemas/Platform",
      "description": "platform selects an exact supported, image-compatible tuple when present.\nexplicit platform requires OS and architecture"
    },
    "policyIds": {
      "description": "policy_ids names existing governance policies, never raw policy content.",
      "items": {
        "minLength": 1,
        "type": "string"
      },
      "type": "array"
    },
    "pullPolicy": {
      "description": "pull_policy retains shared image-pull semantics and explicit support errors.",
      "enum": [
        "unspecified",
        "always"
      ],
      "title": "CreateSandboxRequestPullPolicy",
      "type": "string"
    },
    "resources": {
      "$ref": "#/components/schemas/Resources",
      "description": "resources requests CPU and memory within the selected placement's limits."
    },
    "startupExecution": {
      "$ref": "#/components/schemas/StartupExecution",
      "description": "startup_execution is ordinary create input and persists for\nthe sandbox lifetime."
    }
  }
}
image

Type: string

image is the managed Image resource name.
All schema constraints and annotations
{
  "description": "image is the managed Image resource name.",
  "pattern": "^images/[^/]+$",
  "type": "string"
}
imageRef

Type: string

image_ref is an external OCI reference, with the existing backend validation.
All schema constraints and annotations
{
  "description": "image_ref is an external OCI reference, with the existing backend validation.",
  "type": "string"
}
All schema constraints and annotations
{
  "dependentSchemas": {
    "image": {
      "not": {
        "anyOf": [
          {
            "required": [
              "imageRef"
            ]
          }
        ]
      }
    },
    "imageRef": {
      "not": {
        "anyOf": [
          {
            "required": [
              "image"
            ]
          }
        ]
      }
    }
  },
  "properties": {
    "image": {
      "description": "image is the managed Image resource name.",
      "pattern": "^images/[^/]+$",
      "type": "string"
    },
    "imageRef": {
      "description": "image_ref is an external OCI reference, with the existing backend validation.",
      "type": "string"
    }
  }
}
All schema constraints and annotations
{
  "allOf": [
    {
      "properties": {
        "agent": {
          "description": "agent names an optional agent profile; unsupported profiles fail explicitly.",
          "type": "string"
        },
        "displayName": {
          "description": "(OPTIONAL) display_name is a scoped label; the backend assigns the immutable resource ID.",
          "maxLength": 64,
          "pattern": "^[a-zA-Z0-9_-]*$",
          "type": "string"
        },
        "displayNamePrefix": {
          "description": "(OPTIONAL) display_name_prefix requests a generated label and excludes display_name.",
          "type": "string"
        },
        "environment": {
          "additionalProperties": {
            "title": "value",
            "type": "string"
          },
          "description": "environment is non-secret environment metadata.",
          "type": "object"
        },
        "features": {
          "$ref": "#/components/schemas/FeatureOptions",
          "description": "features carries typed inputs validated before admission can have effects."
        },
        "kits": {
          "description": "kits are the kit inputs to apply before readiness, in composition order.",
          "items": {
            "$ref": "#/components/schemas/KitInput"
          },
          "type": "array"
        },
        "labels": {
          "additionalProperties": {
            "description": "",
            "title": "value",
            "type": "string"
          },
          "description": "labels are non-secret caller-assigned key/value metadata recorded at admission.\nThis contract has no verb that changes labels afterwards.",
          "maxProperties": 64,
          "type": "object"
        },
        "mcp": {
          "$ref": "#/components/schemas/McpCreateSpec",
          "description": "mcp requests an MCP gateway wired before the workload starts."
        },
        "networkPolicies": {
          "description": "network_policies are inline policies materialized in governance and enforced before the first guest process.\nOmission or an empty list requests no inline policies; unsupported policies fail before create effects.",
          "items": {
            "$ref": "#/components/schemas/NetworkPolicy"
          },
          "type": "array"
        },
        "platform": {
          "$ref": "#/components/schemas/Platform",
          "description": "platform selects an exact supported, image-compatible tuple when present.\nexplicit platform requires OS and architecture"
        },
        "policyIds": {
          "description": "policy_ids names existing governance policies, never raw policy content.",
          "items": {
            "minLength": 1,
            "type": "string"
          },
          "type": "array"
        },
        "pullPolicy": {
          "description": "pull_policy retains shared image-pull semantics and explicit support errors.",
          "enum": [
            "unspecified",
            "always"
          ],
          "title": "CreateSandboxRequestPullPolicy",
          "type": "string"
        },
        "resources": {
          "$ref": "#/components/schemas/Resources",
          "description": "resources requests CPU and memory within the selected placement's limits."
        },
        "startupExecution": {
          "$ref": "#/components/schemas/StartupExecution",
          "description": "startup_execution is ordinary create input and persists for\nthe sandbox lifetime."
        }
      }
    },
    {
      "dependentSchemas": {
        "image": {
          "not": {
            "anyOf": [
              {
                "required": [
                  "imageRef"
                ]
              }
            ]
          }
        },
        "imageRef": {
          "not": {
            "anyOf": [
              {
                "required": [
                  "image"
                ]
              }
            ]
          }
        }
      },
      "properties": {
        "image": {
          "description": "image is the managed Image resource name.",
          "pattern": "^images/[^/]+$",
          "type": "string"
        },
        "imageRef": {
          "description": "image_ref is an external OCI reference, with the existing backend validation.",
          "type": "string"
        }
      }
    }
  ],
  "description": "CreateSandboxRequest validates typed composition intent before replay and\npersists accepted guarantees, distinct enough from legacy create that old\nservers cannot silently drop it.\ndisplay_name and display_name_prefix are mutually exclusive At most one of image, imageRef is set.",
  "title": "CreateSandboxRequest",
  "type": "object",
  "unevaluatedProperties": false
}