Create environment

POST /api/v1/cloud/environments Creates a new cloud execution environment for hosting Agent sessions.

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT or SAT>`
`Content-Type`	Yes	`application/json`

Request body

Field	Type	Required	Description
`name`	string	Yes	Non-empty environment name
`description`	string	No	Environment description
`config`	Environment config	No	Environment configuration. Defaults to `{"type":"cloud"}` when omitted
`metadata`	Metadata object	No	Custom metadata. Defaults to `{}`

Example request

curl -s -X POST 'https://api.qoder.com.cn/api/v1/cloud/environments' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "doc-test-env",
    "config": {
      "type": "cloud",
      "packages": {
        "apt": ["curl"]
      }
    }
  }'

Example request: with setup script

curl -s -X POST 'https://api.qoder.com.cn/api/v1/cloud/environments' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "doc-test-env-with-setup",
    "config": {
      "type": "cloud",
      "packages": {
        "npm": ["pnpm@9"]
      },
      "setup_script": "set -euo pipefail\n[ -d /data/workspace/repo/.git ] || git clone https://github.com/me/repo /data/workspace/repo\ncd /data/workspace/repo && pnpm install --frozen-lockfile"
    }
  }'

Example response

HTTP 200 OK

{
  "id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "type": "environment",
  "name": "doc-test-env",
  "description": "",
  "config": {
    "type": "cloud",
    "packages": {
      "type": "packages",
      "apt": ["curl"],
      "cargo": [],
      "gem": [],
      "go": [],
      "npm": [],
      "pip": []
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:07.017808Z"
}

Response fields

Field	Type	Description
`id`	string	Environment unique identifier with the `env_` prefix
`type`	string	Always `"environment"`
`name`	string	Environment name
`description`	string	Environment description
`config`	Environment config	Environment configuration
`metadata`	Metadata object	Custom metadata
`archived_at`	string\|null	Archive time (ISO 8601), `null` when not archived
`created_at`	string	Creation time (ISO 8601)
`updated_at`	string	Last update time (ISO 8601)

Errors

HTTP	Type	Trigger
400	`invalid_request_error`	Missing required field `name`
400	`invalid_request_error`	Invalid `config` or `metadata` value
400	`invalid_request_error`	`config.setup_script` is not a string, or exceeds 64 KB
401	`authentication_error`	PAT or SAT invalid or expired
403	`permission_error`	Not authorized for this operation

See Errors for the full error envelope.

​Headers

​Request body

​Example request

​Example request: with setup script

​Example response

​Response fields

​Errors

Headers

Request body

Example request

Example request: with setup script

Example response

Response fields

Errors