Class: Anthropic::Resources::Beta::Organization::RateLimits

Inherits:

Object

• Object
• Anthropic::Resources::Beta::Organization::RateLimits

Defined in:

lib/anthropic/resources/beta/organization/rate_limits.rb,
sig/anthropic/resources/beta/organization/rate_limits.rbs

Instance Method Summary

• #initialize(client:) ⇒ RateLimits constructor private

  A new instance of RateLimits.

• #list(group_type: nil, limit: nil, model: nil, page: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::Organization::BetaOrganizationRateLimit>

  List Messages API rate limits for your organization.

Constructor Details

#initialize(client:) ⇒ RateLimits

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

Parameters:

• client (Anthropic::Client)
• client: (Anthropic::Client)

# File 'lib/anthropic/resources/beta/organization/rate_limits.rb', line 52

def initialize(client:)
  @client = client
end

Instance Method Details

#list(group_type: nil, limit: nil, model: nil, page: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::Organization::BetaOrganizationRateLimit>

List Messages API rate limits for your organization.

Each entry corresponds to one rate-limit group (either a model family or an API-surface category such as the Files API or Message Batches) and contains the set of limiter values that apply to it.

This endpoint currently returns every matching entry in a single page regardless of limit; follow next_page so that clients keep working when pagination is enabled.

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

Parameters:

• group_type (Symbol, Anthropic::Models::Beta::Organization::RateLimitListParams::GroupType, nil) —

  Filter by group type.

• limit (Integer, nil) —

  Maximum number of items to return per page. Ranges from 1 to 1000.

• model (String, nil) —

  Filter to the single entry containing this model. Accepts full model names and a

• page (String, nil) —

  Opaque cursor from a previous response's next_page.

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

Returns:

• (Anthropic::Internal::PageCursor<Anthropic::Models::Beta::Organization::BetaOrganizationRateLimit>)

See Also:

• Models::Beta::Organization::RateLimitListParams

# File 'lib/anthropic/resources/beta/organization/rate_limits.rb', line 36

def list(params = {})
  parsed, options = Anthropic::Beta::Organization::RateLimitListParams.dump_request(params)
  query = Anthropic::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v1/organizations/rate_limits?beta=true",
    query: query,
    page: Anthropic::Internal::PageCursor,
    model: Anthropic::Beta::Organization::BetaOrganizationRateLimit,
    options: options
  )
end