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

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Environments

Create an agent environment
beta.agents.environments.create(EnvironmentCreateParams**kwargs) -> EnvironmentInfo
POST/agents/environments
List agent environments
beta.agents.environments.list(EnvironmentListParams**kwargs) -> SyncCursorPage[EnvironmentInfo]
GET/agents/environments
Retrieve an agent environment
beta.agents.environments.retrieve(strenvironment_id) -> EnvironmentInfo
GET/agents/environments/{environment_id}
ModelsExpand Collapse
class EnvironmentInfo: …

Safe metadata for a first-class execution environment.

EnvironmentsFiles

Create an agent environment file
beta.agents.environments.files.create(strenvironment_id, FileCreateParams**kwargs) -> EnvironmentFile
POST/agents/environments/{environment_id}/files
List agent environment files
beta.agents.environments.files.list(strenvironment_id, FileListParams**kwargs) -> SyncTokenPage[EnvironmentFile]
GET/agents/environments/{environment_id}/files
ModelsExpand Collapse
class EnvironmentFile: …

A live file in an execution environment.

EnvironmentsTemplates

Create an agent environment template
beta.agents.environments.templates.create(TemplateCreateParams**kwargs) -> EnvironmentTemplate
POST/agents/environments/templates
Delete an agent environment template
beta.agents.environments.templates.delete(strenvironment_template_id) -> EnvironmentTemplateDeleted
DELETE/agents/environments/templates/{environment_template_id}
List agent environment templates
beta.agents.environments.templates.list(TemplateListParams**kwargs) -> SyncCursorPage[EnvironmentTemplate]
GET/agents/environments/templates
Retrieve an agent environment template
beta.agents.environments.templates.retrieve(strenvironment_template_id) -> EnvironmentTemplate
GET/agents/environments/templates/{environment_template_id}
Update an agent environment template
beta.agents.environments.templates.update(strenvironment_template_id, TemplateUpdateParams**kwargs) -> EnvironmentTemplate
POST/agents/environments/templates/{environment_template_id}
ModelsExpand Collapse
class EnvironmentTemplate: …

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

class EnvironmentTemplateDeleted: …

A deleted reusable environment template.