SDK reference | Overlane Docs

Every method of the Overlane TypeScript SDK by area, with the client options and the error type. Generated from the SDK types.

The SDK has one typed method per API operation. Build the client once and call a method:

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

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

For a walkthrough see TypeScript 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.

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

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