POST

Try POST /agents/environments — OpenAI API

OpenAI playground

Create an agent environment

Credentials

OpenAI API key · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.openai.com; the proxy stores and logs nothing about them.

Headers

Idempotency-Key · optional

Body application/json

{
  "environment": {
    "type": "openai_hosted",
    "packages": {
      "python": [
        "example-python"
      ],
      "system": [
        "example-system"
      ],
      "npm": [
        "example-npm"
      ]
    },
    "setup_commands": [
      {
        "command": "example-command",
        "cwd": "example-cwd"
      }
    ],
    "network": {
      "access": "enabled",
      "allowed_domains": [
        "example-allowed-domains"
      ],
      "blocked_domains": [
        "example-blocked-domains"
      ]
    },
    "desktop": {
      "enabled": true
    },
    "env": {},
    "capability_directories": [
      "example-capability-directories"
    ],
    "skills": [
      {
        "type": "skill_reference",
        "skill_id": "example-skill-id",
        "version": "example-version"
      }
    ],
    "plugins": [
      {
        "type": "inline",
        "name": "example-name",
        "description": "example-description",
        "source": {
          "type": "base64",
          "media_type": "application/zip",
          "data": "example-data"
        }
      }
    ],
    "files": [
      {
        "type": "file_id",
        "file_id": "example-file-id",
        "path": "example-path"
      }
    ],
    "environment_template_id": "example-environment-template-id"
  }
}

2 body fields

environment · required · object — Configuration for a new prewarmed OpenAI-hosted environment.
vault_ids · optional · string[] — The IDs of up to 10 vaults made available to an OpenAI-hosted environment.