List containers

Changed on

List Containers

get/containers

Request

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

Query parameters

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order'asc' | 'desc'

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

afterstring

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

namestring

Filter results by container name.

Response

Success

object'list' required

The type of object returned, must be 'list'.

first_idstring required

The ID of the first container in the list.

last_idstring required

The ID of the last container in the list.

has_moreboolean required

Whether there are more containers available.

Changes

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • d86203de41aeRevision changes
    • info

      added the non-success response with the status