Agents

List agent environments

Changed on

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

get/agents/environments

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/agents/environments
  • Auth
    HTTP bearer

Query parameters

limitinteger

The maximum number of resources to return, between 1 and 100. Defaults to 20.

order'asc' | 'desc'

The order in which paginated resources are returned.

The order in which resources are returned. Defaults to desc.

afterstring

Return resources after this resource ID in the selected order.

type'openai_hosted'

The hosting type of an execution environment.

The hosting type to list. Defaults to openai_hosted.

Response

A page of owned environments.

object'list' required

The object type, which is always list.

first_idstring nullable required

The ID of the first resource in data, or null if the page is empty.

last_idstring nullable required

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_moreboolean required

Whether there are more resources to retrieve after this page.

Changes