Sample - OpenAI API
POST/agents/environments/templates

Create an agent environment template

Creates reusable environment configuration without returning confidential setup commands or environment values. See reusing a hosted setup.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

9 body fields
packagesobjectoptional
Packages to install in the environment. Defaults to empty package lists.
setup_commandsarrayoptional
Ordered, confidential setup commands. Command bodies are never returned.
networkobjectoptional
Network access policy for the environment. Defaults to enabled.
envobjectoptional
Environment variables made available to the agent.
capability_directoriesarrayoptional
Directories that contain capabilities exposed to the agent. Defaults to an empty list.
skillsarrayoptional
Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty list.
pluginsarrayoptional
Plugins provided as inline ZIP archives. Defaults to an empty list.
filesarrayoptional
Files available before the agent starts. Defaults to an empty list.
namestringoptional
An optional human-readable display name for the template.

7 status codes
201The created environment template.
idstringrequired
The ID of the reusable environment template.
namestringrequired
An optional human-readable display name for the template.
objectstringrequired
The object type. Always `agent.environment.template`.
Allowed:agent.environment.templateDefault:agent.environment.template
created_atintegerrequired
The Unix timestamp, in seconds, when the template was created.
updated_atintegerrequired
The Unix timestamp, in seconds, when the template was last updated.
packagesobjectrequired
Packages installed in each fresh OpenAI-hosted environment.
networkobjectrequired
Runtime network access for each OpenAI-hosted environment.
capability_directoriesarray<string>required
Directories that expose capabilities to the agent.
skillsarray<object>required
Safe skill metadata, preserving unresolved version selectors.
pluginsarray<object>required
Safe plugin metadata, excluding inline archive contents.
filesarray<object>required
Safe file metadata, excluding contents and session-scoped file IDs.
400The request was invalid.
errorobjectrequired
The error returned by the API.
401Authentication or project context was missing.
errorobjectrequired
The error returned by the API.
403The API key lacks the required management permission.
errorobjectrequired
The error returned by the API.
404The requested environment definition was not found.
errorobjectrequired
The error returned by the API.
500An internal error occurred.
errorobjectrequired
The error returned by the API.
503The service is temporarily unavailable.
errorobjectrequired
The error returned by the API.

Error handling

A 400 is returned: The request was invalid. A 401 is returned: Authentication or project context was missing. A 403 is returned: The API key lacks the required management permission. A 404 is returned: The requested environment definition was not found. A 500 is returned: An internal error occurred. A 503 is returned: The service is temporarily unavailable.