Class: Anthropic::Resources::Beta::Agents

Inherits:
Object
  • Object
show all
Defined in:
lib/anthropic/resources/beta/agents.rb,
lib/anthropic/resources/beta/agents/versions.rb,
sig/anthropic/resources/beta/agents.rbs,
sig/anthropic/resources/beta/agents/versions.rbs

Defined Under Namespace

Classes: Versions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Agents

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 Agents.

Parameters:



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

def initialize(client:)
  @client = client
  @versions = Anthropic::Resources::Beta::Agents::Versions.new(client: client)
end

Instance Attribute Details

#versions ⇒ Anthropic::Resources::Beta::Agents::Versions (readonly)

Returns:



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

def versions
  @versions
end

Instance Method Details

#archive(agent_id, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsAgent

Archive Agent

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

Parameters:

  • agent_id (String) —

    Path parameter agent_id

  • 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/agents.rb', line 207

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

#create(model:, name:, description: nil, mcp_servers: nil, metadata: nil, multiagent: nil, skills: nil, system_: nil, tools: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsAgent

Create Agent

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

Parameters:

Returns:

See Also:



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/anthropic/resources/beta/agents.rb', line 44

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

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

List Agents

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

Parameters:

  • created_at_gte (Time) —

    Query param: Return agents created at or after this time (inclusive).

  • created_at_lte (Time) —

    Query param: Return agents created at or before this time (inclusive).

  • include_archived (Boolean) —

    Query param: Include archived agents in results. Defaults to false.

  • limit (Integer) —

    Query param: Maximum results per page. Default 20, maximum 100.

  • page (String) —

    Query param: Opaque pagination cursor from a previous response.

  • 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:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/anthropic/resources/beta/agents.rb', line 171

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

#retrieve(agent_id, version: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsAgent

Get Agent

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

Parameters:

  • agent_id (String) —

    Path param: Path parameter agent_id

  • version (Integer) —

    Query param: Agent version. Omit for the most recent version. Must be at least 1

  • 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:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/anthropic/resources/beta/agents.rb', line 77

def retrieve(agent_id, params = {})
  query_params = [:version]
  parsed, options = Anthropic::Beta::AgentRetrieveParams.dump_request(params)
  query = Anthropic::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["v1/agents/%1$s?beta=true", agent_id],
    query: query,
    headers: parsed.except(*query_params).transform_keys(
      betas: "anthropic-beta",
      workspace_id: "anthropic-workspace-id"
    ),
    model: Anthropic::Beta::BetaManagedAgentsAgent,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#update(agent_id, description: nil, mcp_servers: nil, metadata: nil, model: nil, multiagent: nil, name: nil, skills: nil, system_: nil, tools: nil, version: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsAgent

Update Agent

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

Parameters:

Returns:

See Also:



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

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