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

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

## docsDependencies

The project's pinned libraries: indexed, stale, private and missing

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

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

## docsIndex

Fetch and index a library's official docs, or refresh an existing index

- Request: `POST` on `/v1/tenants/{tenantId}/docs/index`

```ts
docsIndex(args: { tenantId: string; body: DocsIndexRequest }, options?: CallOptions): Promise<DocsIndexResult>
```

## docsLibraries

Library versions the team has indexed, with their age

- Request: `GET` on `/v1/tenants/{tenantId}/docs/libraries`

```ts
docsLibraries(args: { tenantId: string }, options?: CallOptions): Promise<DocsLibrariesResult>
```

## docsPins

Read version pins from the project's lockfiles (npm, pnpm, yarn, pip, uv, cargo, go)

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

```ts
docsPins(args: { tenantId: string; projectId: string; body: DocsPinsRequest }, options?: CallOptions): Promise<DocsPinsResult>
```

## docsPrivate

Index the team's own docs as a private library

- Request: `POST` on `/v1/tenants/{tenantId}/docs/private`

```ts
docsPrivate(args: { tenantId: string; body: DocsPrivateRequest }, options?: CallOptions): Promise<DocsPrivateResult>
```

## docsQuery

Look up library docs at the pinned version; fetches and indexes the library on first use

- Request: `POST` on `/v1/tenants/{tenantId}/docs/query`

```ts
docsQuery(args: { tenantId: string; body: DocsQueryRequest }, options?: CallOptions): Promise<DocsQueryResult>
```

## docsUsage

This month's library docs calls against the team allowance

- Request: `GET` on `/v1/tenants/{tenantId}/docs/usage`

```ts
docsUsage(args: { tenantId: string }, options?: CallOptions): Promise<DocsUsageResult>
```

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