OpenAI API (unofficial showcase)
GET/agents/environments

List agent environments

Lists OpenAI-hosted environments owned by the authenticated principal. Requires access to the prewarming beta.

4 parameters
limitintegeroptional
The maximum number of resources to return, between 1 and 100. Defaults to 20.
Default:20
orderstringoptional
The order in which resources are returned. Defaults to `desc`.
Allowed:ascdescDefault:desc
afterstringoptional
Return resources after this resource ID in the selected order.
typestringoptional
The hosting type to list. Defaults to `openai_hosted`.
Allowed:openai_hosted

8 status codes
200A page of owned environments.
objectstringrequired
The object type, which is always `list`.
Allowed:listDefault:list
dataarray<object>required
The resources returned in this page, in the requested sort order.
first_idstringrequired
The ID of the first resource in `data`, or `null` if the page is empty.
last_idstringrequired
The ID of the last resource in `data`, or `null` if the page is empty. Pass this as `after` with the same order and filters.
has_morebooleanrequired
Whether there are more resources to retrieve after this page.
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 permission.
errorobjectrequired
The error returned by the API.
404The requested environment or referenced resource 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 permission. A 404 is returned: The requested environment or referenced resource 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.