Get sandbox details

Use the actual ID returned by listing/creation to read sandbox phase, specification, and network settings.

GET https://api.moi.matrixorigin.cn/v5/agent-sandboxes/{sandbox_id}

Before you call this API

Prepare a personal access token and the required privileges for the target workspace. Keep environment, token, workspace, and sandbox ID consistent. Common objects and result confirmation explains identities, fields, and states. Replace example resource values with actual ones.

Request

curl "https://api.moi.matrixorigin.cn/v5/agent-sandboxes/$SANDBOX_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

sandbox_id is a required path string from data[].id or creation data.id. The object must belong to the same workspace and be visible to the current identity. Display name, edge_agent_id, and ephemeral-session identities are not substitutes.

Successful response

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": "sbx-example",
    "workspace_id": "workspace-example",
    "user_id": "user-example",
    "name": "audit-runner",
    "phase": "ready",
    "edge_agent_id": "sbx-example",
    "network_mode": "limited",
    "network_tools": [
      "git",
      "curl"
    ],
    "egress_endpoints": [
      {
        "host": "example.com",
        "ports": [
          443
        ]
      }
    ],
    "spec": "medium",
    "disk_gi": 10,
    "created_at": "2026-11-11T08:00:00Z",
    "updated_at": "2026-11-11T08:00:00Z",
    "update_available": null
  }
}

Meaning of HTTP 200 data below. Example values are not default configuration.

Field

Type

Description

code

string

OK on success.

msg

string

Response explanation.

data

object

Current sandbox; see common objects for all fields.

Confirm the result

After phase:ready, verify the target terminal/job. provisioning means preparation continues. Handle unknown/error using actual errors; GET success does not establish healthy execution. update_available:null is unknown, not no update.

Error handling

Check HTTP status and response code. Shared errors and recovery distinguishes parameter, permission, quota, provider, and unknown-result cases. Errors do not prove that no resource was created or that retry/cleanup completed.

Last updated on