Skip to content

SandboxState ​

Type: object

FieldRequiredTypeDescription and constraints
errorYesError / null
idYesstring / nullAgentBox sandbox ID, if known. Retained for diagnostics after deletion or loss; does not guarantee accessibility.
last_known_stateYesstring / null
stateYesstringenum: ["not_created","provisioning","ready","pausing","paused","resuming","deleting","deleted","unavailable"]
workspaceYesstring / nullAbsolute workspace path resolved during sandbox preparation, if known.

JSON Schema ​

json
{
  "properties": {
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/Error"
        },
        {
          "type": "null"
        }
      ]
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "AgentBox sandbox ID, if known. Retained for diagnostics after deletion or loss; does not guarantee accessibility."
    },
    "last_known_state": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Known State"
    },
    "state": {
      "enum": [
        "not_created",
        "provisioning",
        "ready",
        "pausing",
        "paused",
        "resuming",
        "deleting",
        "deleted",
        "unavailable"
      ],
      "title": "State",
      "type": "string"
    },
    "workspace": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Absolute workspace path resolved during sandbox preparation, if known."
    }
  },
  "required": [
    "state",
    "last_known_state",
    "error",
    "id",
    "workspace"
  ],
  "title": "SandboxState",
  "type": "object"
}

All schemas · HTTP API