Class: AIGatewayRateLimitsClient

Defined in: src/ai-gateway/rate-limits-client.ts:30

Workspace-scoped rateLimits operations on the SCM data plane.

Example

`const client = new AIGatewayClient().rateLimits;`

Constructors

Constructor

new AIGatewayRateLimitsClient(options): AIGatewayRateLimitsClient;

Defined in: src/ai-gateway/rate-limits-client.ts:31

Parameters

Parameter	Type
options	AIGatewaySubClientOptions

Returns

AIGatewayRateLimitsClient

Methods

list()

list(opts?): Promise<{
[key: string]: unknown;
  object?: string;
  data?: {
   [key: string]: unknown;
     id: string;
     name?: string | null;
     conditions?: {
      [key: string]: unknown;
        key: string;
        value: string | string[];
        excludes?: string | string[];
     }[];
     group_by?: {
      [key: string]: unknown;
        key: string;
     }[];
     type: string;
     unit: string;
     value: number;
     status: string;
     workspace_id: string;
     organisation_id: string;
     created_at: string;
     last_updated_at: string;
     target?: string;
  }[];
  total?: number;
}>;

Defined in: src/ai-gateway/rate-limits-client.ts:37

List Rate Limits Policies. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
opts	{ workspace_id?: string; status?: string; type?: string; unit?: string; target?: string; page_size?: number; current_page?: number; }
opts.workspace_id?	string
opts.status?	string
opts.type?	string
opts.unit?	string
opts.target?	string
opts.page_size?	number
opts.current_page?	number

Returns

Promise<{ [key: string]: unknown; object?: string; data?: { [key: string]: unknown; id: string; name?: string | null; conditions?: { [key: string]: unknown; key: string; value: string | string[]; excludes?: string | string[]; }[]; group_by?: { [key: string]: unknown; key: string; }[]; type: string; unit: string; value: number; status: string; workspace_id: string; organisation_id: string; created_at: string; last_updated_at: string; target?: string; }[]; total?: number; }>

Example

`await gw.rateLimits.list({});`

---

create()

create(body): Promise<{
[key: string]: unknown;
  id?: string;
  object?: string;
}>;

Defined in: src/ai-gateway/rate-limits-client.ts:55

Create Rate Limits Policy. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
body	{ name?: string; conditions: { key: string; value: string | string[]; excludes?: string | string[]; }[]; group_by: { key: string; }[]; type: string; unit: string; value: number; target?: string; workspace_id?: string; organisation_id?: string; }
body.name?	string
body.conditions	{ key: string; value: string | string[]; excludes?: string | string[]; }[]
body.group_by	{ key: string; }[]
body.type	string
body.unit	string
body.value	number
body.target?	string
body.workspace_id?	string
body.organisation_id?	string

Returns

Promise<{ [key: string]: unknown; id?: string; object?: string; }>

Example

`await gw.rateLimits.create(body);`

---

get()

get(rateLimitsPolicyId, opts?): Promise<{
[key: string]: unknown;
  id: string;
  name?: string | null;
  conditions?: {
   [key: string]: unknown;
     key: string;
     value: string | string[];
     excludes?: string | string[];
  }[];
  group_by?: {
   [key: string]: unknown;
     key: string;
  }[];
  type: string;
  unit: string;
  value: number;
  status: string;
  workspace_id: string;
  organisation_id: string;
  created_at: string;
  last_updated_at: string;
  target?: string;
} & {
[key: string]: unknown;
  object?: string;
}>;

Defined in: src/ai-gateway/rate-limits-client.ts:74

Get Rate Limits Policy. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
rateLimitsPolicyId	string
opts	{ status?: string; }
opts.status?	string

Returns

Promise<{ [key: string]: unknown; id: string; name?: string | null; conditions?: { [key: string]: unknown; key: string; value: string | string[]; excludes?: string | string[]; }[]; group_by?: { [key: string]: unknown; key: string; }[]; type: string; unit: string; value: number; status: string; workspace_id: string; organisation_id: string; created_at: string; last_updated_at: string; target?: string; } & { [key: string]: unknown; object?: string; }>

Example

`await gw.rateLimits.get('resource-id', {});`

---

update()

update(rateLimitsPolicyId, body): Promise<{
[key: string]: unknown;
}>;

Defined in: src/ai-gateway/rate-limits-client.ts:94

Update Rate Limits Policy. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
rateLimitsPolicyId	string
body	{ name?: string; unit?: string; value?: number; conditions?: { key: string; value: string | string[]; excludes?: string | string[]; }[]; }
body.name?	string
body.unit?	string
body.value?	number
body.conditions?	{ key: string; value: string | string[]; excludes?: string | string[]; }[]

Returns

Promise<{ [key: string]: unknown; }>

Example

`await gw.rateLimits.update('resource-id', body);`

---

delete()

delete(rateLimitsPolicyId): Promise<{
[key: string]: unknown;
}>;

Defined in: src/ai-gateway/rate-limits-client.ts:115

Delete Rate Limits Policy. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
rateLimitsPolicyId	string

Returns

Promise<{ [key: string]: unknown; }>

Example

`await gw.rateLimits.delete('resource-id');`