Retrieve container
containers.retrieve(container_id) -> ContainerRetrieveResponse
get /containers/{container_id}
Retrieve Container
Parameters
container_id: String
Returns
-
class ContainerRetrieveResponse-
id: StringUnique identifier for the container.
-
created_at: IntegerUnix timestamp (in seconds) when the container was created.
-
name: StringName of the container.
-
object: StringThe type of this object.
-
status: StringStatus of the container (e.g., active, deleted).
-
expires_after: ExpiresAfter{ anchor, minutes}The container will expire after this time period. The anchor is the reference point for the expiration. The minutes is the number of minutes after the anchor before the container expires.
-
anchor: :last_active_atThe reference point for the expiration.
:last_active_at
-
minutes: IntegerThe number of minutes after the anchor before the container expires.
-
-
last_active_at: IntegerUnix timestamp (in seconds) when the container was last active.
-
memory_limit: :"1g" | :"4g" | :"16g" | :"64g"The memory limit configured for the container.
-
:"1g" -
:"4g" -
:"16g" -
:"64g"
-
-
network_policy: NetworkPolicy{ type, allowed_domains}Network access policy for the container.
-
type: :allowlist | :disabledThe network policy mode.
-
:allowlist -
:disabled
-
-
allowed_domains: Array[String]Allowed outbound domains when
typeisallowlist.
-
-
Example
require "openai"
openai = OpenAI::Client.new(api_key: "My API Key")
container = openai.containers.retrieve("container_id")
puts(container)
Response
{
"id": "id",
"created_at": 0,
"name": "name",
"object": "object",
"status": "status",
"expires_after": {
"anchor": "last_active_at",
"minutes": 0
},
"last_active_at": 0,
"memory_limit": "1g",
"network_policy": {
"type": "allowlist",
"allowed_domains": [
"string"
]
}
}