---
title: "SDK: claims"
description: "The claims 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: claims

{/* 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 `claims` area has 12 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/)).

## claimsAcquire

Claim paths for a task so parallel agents do not collide

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/claims`

```ts
claimsAcquire(args: { tenantId: string; projectId: string; body: AcquireClaimRequest }, options?: CallOptions): Promise<ClaimOutcome>
```

## claimsChecksList

List recorded merge-tree checks between branches

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/claims/merge-checks`

```ts
claimsChecksList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## claimsChecksPending

Branch pairs that still need a merge-tree check

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/claims/merge-checks/pending`

```ts
claimsChecksPending(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## claimsChecksRecord

Record a merge-tree check between two branches

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/claims/merge-checks`

```ts
claimsChecksRecord(args: { tenantId: string; projectId: string; body: RecordMergeCheckRequest }, options?: CallOptions): Promise<MergeCheckRecord>
```

## claimsChecksRun

Run a merge-tree check between two branches

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/claims/merge-checks/run`

```ts
claimsChecksRun(args: { tenantId: string; projectId: string; body: RunMergeCheckRequest }, options?: CallOptions): Promise<Record<string, unknown>>
```

## claimsGet

Read one claim

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

```ts
claimsGet(args: { tenantId: string; projectId: string; claimId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## claimsList

List claims on paths in a project

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

```ts
claimsList(args: { tenantId: string; projectId: string; query?: { status?: string; task?: string } }, options?: CallOptions): Promise<ClaimListResponse>
```

## claimsReadiness

Whether a claim's branch is ready to merge

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/claims/{claimId}/readiness`

```ts
claimsReadiness(args: { tenantId: string; projectId: string; claimId: string }, options?: CallOptions): Promise<MergeReadiness>
```

## claimsRelease

Release a claim

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/claims/{claimId}/release`

```ts
claimsRelease(args: { tenantId: string; projectId: string; claimId: string; body: ReleaseClaimRequest }, options?: CallOptions): Promise<Claim>
```

## claimsRenew

Renew a claim before it lapses

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/claims/{claimId}/renew`

```ts
claimsRenew(args: { tenantId: string; projectId: string; claimId: string; body: RenewClaimRequest }, options?: CallOptions): Promise<Claim>
```

## claimsSettingsGet

Read a project's claim settings

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

```ts
claimsSettingsGet(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## claimsSettingsPut

Change a project's claim settings

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

```ts
claimsSettingsPut(args: { tenantId: string; projectId: string; body: PutClaimSettingsRequest }, options?: CallOptions): Promise<Record<string, unknown>>
```

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