---
title: "SDK: rules"
description: "The rules methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

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

# SDK: rules

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `rules` area has 2 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## rulesGet

The rules text the project's task payloads use

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/rules`

```ts
rulesGet(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<ProjectRules>
```

## rulesPut

Set the rules text the project's task payloads use (the text of the rules source file)

- Request: `PUT` on `/v1/tenants/{tenantId}/projects/{projectId}/rules`

```ts
rulesPut(args: { tenantId: string; projectId: string; body: SetRulesRequest }, options?: CallOptions): Promise<ProjectRules>
```

Source: https://docs.overlane.app/sdk/rules/index.mdx