创建环境

通过 OMA API 创建环境。

POST /v1/environments

创建环境

cURL

curl --request POST \
  --url http://localhost:38080/v1/environments \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "python-data-analysis"
}
'

200

{
  "type": "environment",
  "id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
  "name": "python-data-analysis",
  "description": "包含数据分析包的 Python 环境。",
  "config": {
    "type": "cloud",
    "networking": {
      "type": "limited",
      "allowed_hosts": [
        "api.example.com"
      ],
      "allow_package_managers": true,
      "allow_mcp_servers": false
    },
    "packages": {
      "type": "packages",
      "pip": [
        "pandas",
        "numpy"
      ],
      "npm": [],
      "apt": [],
      "cargo": [],
      "gem": [],
      "go": []
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z"
}

每个请求都必须发送 ?beta=true。

授权

omaApiKeyomaBearer

X-Api-Key · string · header · 默认值: sk-ant-local-default · 必填

OMA 工作区 API 密钥。

请求头

anthropic-beta · string

用于指定要使用的 beta 版本的可选请求头。

要使用多个 beta，请使用逗号分隔的列表（如 beta1,beta2），或为每个 beta 分别指定该请求头。

anthropic-version · string

你想使用的 OMA API 版本。

在此处阅读更多关于版本控制和我们版本历史的信息。

查询参数

beta · enum<boolean> · 必填

为此接口启用 Beta API 合同，必须为 true。

可用选项: true

请求体

application/json

创建新环境的公开 API 请求（不包含 org/account 字段）。

name · string · 必填

环境的人类可读名称

Required string length: 1 - 256

示例:

"python-data-analysis"

config · CloudConfigParams · object

cloud 环境配置的请求参数。

字段默认为 null；更新时，省略的字段将保留 现有值。

CloudConfigParams

SelfHostedConfigParams

Show child attributes

示例:

{
  "type": "cloud",
  "networking": {
    "type": "limited",
    "allowed_hosts": ["api.example.com"],
    "allow_package_managers": true
  },
  "packages": { "pip": ["pandas", "numpy"] }
}

description · string | null

环境的可选描述

Maximum string length: 1024

示例:

"包含数据分析软件包的 Python 环境。"

metadata · 元数据 · object

用户提供的元数据键值对

Show child attributes

scope · enum<string> | null

此环境的可见范围。'organization' 使该环境对所有账户可见。'account' 将可见性限制为仅所属账户。仅适用于自托管环境。未指定时，根据组织类型确定默认值。

可用选项: organization, account

响应

200

application/json

成功的响应

适用于云端和自托管环境的统一环境资源。

archived_at · string | null · 必填

环境被归档时的 RFC 3339 时间戳，未归档时为 null

示例:

null

config · CloudConfig · object · 必填

cloud 环境配置。

CloudConfig

SelfHostedConfig

Show child attributes

示例:

{
  "type": "cloud",
  "networking": {
    "type": "limited",
    "allowed_hosts": ["api.example.com"],
    "allow_package_managers": true,
    "allow_mcp_servers": false
  },
  "packages": {
    "type": "packages",
    "pip": ["pandas", "numpy"],
    "npm": [],
    "apt": [],
    "cargo": [],
    "gem": [],
    "go": []
  }
}

created_at · string · 必填

环境创建时间的 RFC 3339 时间戳

示例:

"2026-03-15T10:00:00Z"

description · string · 必填

用户提供的环境描述

示例:

"包含数据分析软件包的 Python 环境。"

id · string · 必填

环境标识符（例如 'env_...'）

示例:

"env_011CZkZ9X2dpNyB7HsEFoRfW"

metadata · 元数据 · object · 必填

用户提供的元数据键值对

Show child attributes

示例:

{ "key": "value" }

name · string · 必填

环境的人类可读名称

示例:

"python-data-analysis"

type · string · 默认值: environment · 必填

对象类型（始终为 'environment'）

Allowed value: "environment"

示例:

"environment"

updated_at · string · 必填

环境最后更新时间的 RFC 3339 时间戳

示例:

"2026-03-15T10:00:00Z"

scope · enum<string>

此环境的可见性范围。'organization' 表示对所有账号可见。'account' 表示仅对所属账号可见。

可用选项: organization, account