Class: Anthropic::Resources::Beta::Environments

Inherits:
Object
  • Object
show all
Defined in:
lib/anthropic/resources/beta/environments.rb,
lib/anthropic/resources/beta/environments/work.rb

Defined Under Namespace

Classes: Work

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Environments

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Environments.

Parameters:



197
198
199
200
 
# File 'lib/anthropic/resources/beta/environments.rb', line 197

def initialize(client:)
  @client = client
  @work = Anthropic::Resources::Beta::Environments::Work.new(client: client)
end

Instance Attribute Details

#work ⇒ Anthropic::Resources::Beta::Environments::Work (readonly)

Returns:



8
9
10
 
# File 'lib/anthropic/resources/beta/environments.rb', line 8

def work
  @work
end

Instance Method Details

#archive(environment_id, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironment

Archive an environment by ID. Archived environments cannot be used to create new sessions.

Parameters:

Returns:

See Also:



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/anthropic/resources/beta/environments.rb', line 183

def archive(environment_id, params = {})
  parsed, options = Anthropic::Beta::EnvironmentArchiveParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/environments/%1$s/archive?beta=true", environment_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::BetaEnvironment,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#create(name:, config: nil, description: nil, metadata: nil, scope: nil, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironment

Some parameter documentations has been truncated, see Models::Beta::EnvironmentCreateParams for more details.

Create a new environment with the specified configuration.

Parameters:

Returns:

See Also:



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/anthropic/resources/beta/environments.rb', line 34

def create(params)
  parsed, options = Anthropic::Beta::EnvironmentCreateParams.dump_request(params)
  header_params = {betas: "anthropic-beta"}
  @client.request(
    method: :post,
    path: "v1/environments?beta=true",
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Anthropic::Beta::BetaEnvironment,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#delete(environment_id, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironmentDeleteResponse

Delete an environment by ID. Returns a confirmation of the deletion.

Parameters:

Returns:

See Also:



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/anthropic/resources/beta/environments.rb', line 158

def delete(environment_id, params = {})
  parsed, options = Anthropic::Beta::EnvironmentDeleteParams.dump_request(params)
  @client.request(
    method: :delete,
    path: ["v1/environments/%1$s?beta=true", environment_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::BetaEnvironmentDeleteResponse,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#list(include_archived: nil, limit: nil, page: nil, betas: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::BetaEnvironment>

Some parameter documentations has been truncated, see Models::Beta::EnvironmentListParams for more details.

List environments with pagination support.

Parameters:

  • include_archived (Boolean) —

    Query param: Include archived environments in the response

  • limit (Integer) —

    Query param: Maximum number of environments to return

  • page (String, nil) —

    Query param: Opaque cursor from previous response for pagination. Pass the ‘next

  • betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

    Header param: Optional header to specify the beta version(s) you want to use.

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/anthropic/resources/beta/environments.rb', line 130

def list(params = {})
  query_params = [:include_archived, :limit, :page]
  parsed, options = Anthropic::Beta::EnvironmentListParams.dump_request(params)
  query = Anthropic::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: "v1/environments?beta=true",
    query: query,
    headers: parsed.except(*query_params).transform_keys(betas: "anthropic-beta"),
    page: Anthropic::Internal::PageCursor,
    model: Anthropic::Beta::BetaEnvironment,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#retrieve(environment_id, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironment

Retrieve a specific environment by ID.

Parameters:

Returns:

See Also:



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/anthropic/resources/beta/environments.rb', line 60

def retrieve(environment_id, params = {})
  parsed, options = Anthropic::Beta::EnvironmentRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["v1/environments/%1$s?beta=true", environment_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::BetaEnvironment,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#update(environment_id, config: nil, description: nil, metadata: nil, name: nil, scope: nil, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironment

Some parameter documentations has been truncated, see Models::Beta::EnvironmentUpdateParams for more details.

Update an existing environment’s configuration.

Parameters:

Returns:

See Also:



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/anthropic/resources/beta/environments.rb', line 97

def update(environment_id, params = {})
  parsed, options = Anthropic::Beta::EnvironmentUpdateParams.dump_request(params)
  header_params = {betas: "anthropic-beta"}
  @client.request(
    method: :post,
    path: ["v1/environments/%1$s?beta=true", environment_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Anthropic::Beta::BetaEnvironment,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end