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,
sig/anthropic/resources/beta/environments.rbs,
sig/anthropic/resources/beta/environments/work.rbs

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:



221
222
223
224
 
# File 'lib/anthropic/resources/beta/environments.rb', line 221

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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironment

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

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

Parameters:

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

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

  • workspace_id (String) —

    Optional header to select the Workspace for this request. The value is a Workspa

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

Returns:

See Also:



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/anthropic/resources/beta/environments.rb', line 207

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", workspace_id: "anthropic-workspace-id"),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironment

Create a new environment with the specified configuration.

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

Parameters:

Returns:

See Also:



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

def create(params)
  parsed, options = Anthropic::Beta::EnvironmentCreateParams.dump_request(params)
  header_params = {betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"}
  @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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironmentDeleteResponse

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

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

Parameters:

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

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

  • workspace_id (String) —

    Optional header to select the Workspace for this request. The value is a Workspa

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

Returns:

See Also:



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/anthropic/resources/beta/environments.rb', line 177

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", workspace_id: "anthropic-workspace-id"),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::BetaEnvironment>

List environments with pagination support.

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

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.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

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

Returns:

See Also:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/anthropic/resources/beta/environments.rb', line 141

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",
      workspace_id: "anthropic-workspace-id"
    ),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironment

Retrieve a specific environment by ID.

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

Parameters:

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

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

  • workspace_id (String) —

    Optional header to select the Workspace for this request. The value is a Workspa

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

Returns:

See Also:



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/anthropic/resources/beta/environments.rb', line 67

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", workspace_id: "anthropic-workspace-id"),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaEnvironment

Update an existing environment's configuration.

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

Parameters:

Returns:

See Also:



106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/anthropic/resources/beta/environments.rb', line 106

def update(environment_id, params = {})
  parsed, options = Anthropic::Beta::EnvironmentUpdateParams.dump_request(params)
  header_params = {betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"}
  @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