Sample - OpenAI API
POST/agents/environments/templates/{environment_template_id}

Update an agent environment template

Updates reusable environment configuration without returning confidential values. See reusing a hosted setup.

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

1 parameter · 9 body fields
environment_template_idstringrequired
The ID of the reusable environment template.
namestringoptional
A replacement human-readable display name, or `null` to clear the name.
packagesobjectoptional
Packages installed before the runtime network policy applies.
setup_commandsarrayoptional
Replacement confidential setup commands, never included in returned resources.
networkobjectoptional
Network access available after setup completes.
envobjectoptional
Replacement confidential environment values.
capability_directoriesarrayoptional
Directories that expose capabilities to the agent.
skillsarrayoptional
Replacement skill configuration installed for each new session.
pluginsarrayoptional
Replacement plugin configuration installed for each new session.
filesarrayoptional
Replacement file configuration materialized for each new session.

8 status codes
200The updated 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.
409The request conflicted with the current environment state.
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 409 is returned: The request conflicted with the current environment state. A 500 is returned: An internal error occurred. A 503 is returned: The service is temporarily unavailable.