Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation
Theme

Create an agent environment

client.beta.agents.environments.create(params, options?): EnvironmentInfo { id, files, object, 4 more }
POST
/agents/environments

Creates an OpenAI-hosted environment before creating a session. Requires access to the prewarming beta.

Parameters
params: EnvironmentCreateParams { environment, vault_ids, idempotencyKey }
environment: Environment

Body param: The required hosting type and its configuration.

vault_ids?: Array<string> | null

Body param: The IDs of up to 10 vaults made available to an OpenAI-hosted environment.

minItems0
maxItems10
idempotencyKey?: string

Header param: Deduplicates creation for 24 hours within the authenticated organization, project, and creator. Retry the same JSON parameters with the same key to retrieve the original environment in its current state. Different parameters or an incomplete hosted creation return 409. Deleted environments are not recreated. After retention expires, the key may create a new environment. Without this header, each request creates a new environment.

minLength1
maxLength256
Returns
EnvironmentInfo { id, files, object, 4 more }

Safe metadata for a first-class execution environment.

id: string

The ID of the environment.

minLength0
files: Array<HostedEnvironmentFile>

Files installed in the environment, without their contents.

minItems0
maxItems2000
object: "agent.environment"

The object type. Always agent.environment.

plugins: Array<HostedPlugin { description, name, type } >

Plugins installed in the environment, without their archive contents.

minItems0
maxItems2000
skills: Array<HostedSkill>

Skills installed in the environment, without their archive contents.

minItems0
maxItems2000
status: "pending" | "ready" | "connected" | 4 more

The current environment connection status.

type: "openai_hosted" | "self_hosted"

Whether the environment is hosted by OpenAI or by the application.

Create an agent environment

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const environmentInfo = await client.beta.agents.environments.create({
  environment: { type: 'openai_hosted' },
});

console.log(environmentInfo.id);
201 — Example
{
  "id": "id",
  "files": [
    {
      "id": "id",
      "file_id": "file_id",
      "path": "path",
      "size_bytes": 0,
      "type": "file_id"
    }
  ],
  "object": "agent.environment",
  "plugins": [
    {
      "description": "description",
      "name": "name",
      "type": "inline"
    }
  ],
  "skills": [
    {
      "description": "description",
      "name": "name",
      "skill_id": "skill_id",
      "type": "skill_reference",
      "version": "version"
    }
  ],
  "status": "pending",
  "type": "openai_hosted"
}
Returns Examples
201 — Example
{
  "id": "id",
  "files": [
    {
      "id": "id",
      "file_id": "file_id",
      "path": "path",
      "size_bytes": 0,
      "type": "file_id"
    }
  ],
  "object": "agent.environment",
  "plugins": [
    {
      "description": "description",
      "name": "name",
      "type": "inline"
    }
  ],
  "skills": [
    {
      "description": "description",
      "name": "name",
      "skill_id": "skill_id",
      "type": "skill_reference",
      "version": "version"
    }
  ],
  "status": "pending",
  "type": "openai_hosted"
}