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

Environments

Create an agent environment
beta.agents.environments.create(**kwargs) -> EnvironmentInfo { id, files, object, 4 more }
POST
/agents/environments
List agent environments
beta.agents.environments.list(**kwargs) -> CursorPage<EnvironmentInfo { id, files, object, 4 more } >
GET
/agents/environments
Retrieve an agent environment
beta.agents.environments.retrieve(environment_id) -> EnvironmentInfo { id, files, object, 4 more }
GET
/agents/environments/{environment_id}
Models
class EnvironmentInfo { id, files, object, 4 more }

Safe metadata for a first-class execution environment.

EnvironmentsFiles

Write an agent environment file
beta.agents.environments.files.create(environment_id, **kwargs) -> EnvironmentFile { environment_id, object, path, size_bytes }
POST
/agents/environments/{environment_id}/files
List agent environment files
beta.agents.environments.files.list(environment_id, **kwargs) -> TokenPage<EnvironmentFile { environment_id, object, path, size_bytes } >
GET
/agents/environments/{environment_id}/files
Models
class EnvironmentFile { environment_id, object, path, size_bytes }

A live file in an execution environment.

EnvironmentsTemplates

Create an agent environment template
beta.agents.environments.templates.create(**kwargs) -> EnvironmentTemplate { id, capability_directories, created_at, 9 more }
POST
/agents/environments/templates
Delete an agent environment template
beta.agents.environments.templates.delete(environment_template_id) -> EnvironmentTemplateDeleted { id, deleted, object }
DELETE
/agents/environments/templates/{environment_template_id}
List agent environment templates
beta.agents.environments.templates.list(**kwargs) -> CursorPage<EnvironmentTemplate { id, capability_directories, created_at, 9 more } >
GET
/agents/environments/templates
Retrieve an agent environment template
beta.agents.environments.templates.retrieve(environment_template_id) -> EnvironmentTemplate { id, capability_directories, created_at, 9 more }
GET
/agents/environments/templates/{environment_template_id}
Update an agent environment template
beta.agents.environments.templates.update(environment_template_id, **kwargs) -> EnvironmentTemplate { id, capability_directories, created_at, 9 more }
POST
/agents/environments/templates/{environment_template_id}
Models
class EnvironmentTemplate { id, capability_directories, created_at, 9 more }

Reusable configuration that provisions a fresh OpenAI-hosted environment for each session.

class EnvironmentTemplateDeleted { id, deleted, object }

A deleted reusable environment template.