> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revoengine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# api.rateLimit()

> Public low-code contract, signatures and examples for api.rateLimit.

## `api.rateLimit()`

Acquires an instance-scoped rate-limit token.

Notes:

* Unavailable with `readOnly: true` (throws an error).

### Signature

```ts theme={null}
static rateLimit(key: string, limit: number, ttl: number): Promise<boolean>;
```

### Example

```ts theme={null}
const allowed = await api.rateLimit('outbound:crm', 10, 60);
```

See [all api methods](https://docs.revoengine.com/low-code/reference/api.md) or [runtime basics](https://docs.revoengine.com/low-code/overview.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.