---
title: "SDK reference"
description: "Every method of the Overlane TypeScript SDK by area, with the client options and the error type. 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 reference

{/* 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 SDK has one typed method per API operation. Build the client once and call a method:

```ts
import { Overlane } from "@overlane/sdk";

const overlane = new Overlane({ apiKey: "ovl_k_..." });
```

For a walkthrough see [TypeScript SDK](/developers/sdk/).

## Client options

| Option | Description |
| --- | --- |
| `apiKey: string` | A team API key (`ovl_k_...`) or an agent token. |
| `baseUrl?: string` |  |
| `version?: string` | The API version, a date. Sent as the `Overlane-Version` header; the version this SDK was generated from by default. |
| `fetch?: typeof fetch` |  |
| `maxRetries?: number` | Retries of a read that was rate limited or hit a server error. Writes are never retried. Default 2. |
| `sleep?: (ms: number) => Promise<void>` | Waits between retries; tests pass a no-op. |

## Call options

| Option | Description |
| --- | --- |
| `approvalId?: string` | An autonomy approval ID, sent as `x-overlane-approval` for a call that needs one. |
| `signal?: AbortSignal` |  |

## Errors

A non-2xx answer rejects with `OverlaneApiError`, which carries these fields.

| Field | Type |
| --- | --- |
| `status` | `number` |
| `code` | `string` |
| `hint` | `string \| undefined` |
| `retryable` | `boolean` |
| `retryAfterSeconds` | `number \| undefined` |
| `body` | `unknown` |

## Areas

| Area | Methods |
| --- | --- |
| [agent](/sdk/agent/) | 9 |
| [apikeys](/sdk/apikeys/) | 4 |
| [approvals](/sdk/approvals/) | 3 |
| [audit](/sdk/audit/) | 3 |
| [auth](/sdk/auth/) | 2 |
| [autonomy](/sdk/autonomy/) | 6 |
| [billing](/sdk/billing/) | 16 |
| [bots](/sdk/bots/) | 6 |
| [budgets](/sdk/budgets/) | 6 |
| [ci](/sdk/ci/) | 26 |
| [claims](/sdk/claims/) | 12 |
| [code](/sdk/code/) | 14 |
| [codemap](/sdk/codemap/) | 1 |
| [connectors](/sdk/connectors/) | 14 |
| [cycles](/sdk/cycles/) | 6 |
| [decision](/sdk/decision/) | 2 |
| [deploy](/sdk/deploy/) | 13 |
| [docs](/sdk/docs/) | 7 |
| [egress](/sdk/egress/) | 9 |
| [enterprise](/sdk/enterprise/) | 31 |
| [events](/sdk/events/) | 2 |
| [features](/sdk/features/) | 3 |
| [git](/sdk/git/) | 34 |
| [github](/sdk/github/) | 3 |
| [guard](/sdk/guard/) | 7 |
| [imports](/sdk/imports/) | 2 |
| [inbox](/sdk/inbox/) | 6 |
| [intent](/sdk/intent/) | 6 |
| [invitations](/sdk/invitations/) | 4 |
| [issues](/sdk/issues/) | 10 |
| [issuesync](/sdk/issuesync/) | 2 |
| [jobs](/sdk/jobs/) | 1 |
| [kit](/sdk/kit/) | 20 |
| [labels](/sdk/labels/) | 6 |
| [links](/sdk/links/) | 1 |
| [loops](/sdk/loops/) | 7 |
| [mcp](/sdk/mcp/) | 2 |
| [me](/sdk/me/) | 4 |
| [members](/sdk/members/) | 3 |
| [memory](/sdk/memory/) | 14 |
| [models](/sdk/models/) | 4 |
| [observe](/sdk/observe/) | 25 |
| [onboarding](/sdk/onboarding/) | 4 |
| [openapi](/sdk/openapi/) | 1 |
| [operator](/sdk/operator/) | 8 |
| [projects](/sdk/projects/) | 10 |
| [prroutes](/sdk/prroutes/) | 6 |
| [queue](/sdk/queue/) | 5 |
| [ratelimit](/sdk/ratelimit/) | 1 |
| [release](/sdk/release/) | 2 |
| [releases](/sdk/releases/) | 7 |
| [review](/sdk/review/) | 7 |
| [rules](/sdk/rules/) | 2 |
| [signals](/sdk/signals/) | 4 |
| [skills](/sdk/skills/) | 5 |
| [tasks](/sdk/tasks/) | 14 |
| [teams](/sdk/teams/) | 1 |
| [tokens](/sdk/tokens/) | 3 |
| [versions](/sdk/versions/) | 1 |
| [views](/sdk/views/) | 7 |
| [webhooks](/sdk/webhooks/) | 6 |
| [wiki](/sdk/wiki/) | 2 |
| [workprojects](/sdk/workprojects/) | 6 |
| [workspace](/sdk/workspace/) | 2 |

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