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

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

## kitAttemptsRecord

Record a finished loop iteration and judge the task

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

```ts
kitAttemptsRecord(args: { tenantId: string; projectId: string; body: AttemptReport }, options?: CallOptions): Promise<AttemptResult>
```

## kitNext

The next task a run should take

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

```ts
kitNext(args: { tenantId: string; projectId: string; query?: { executor?: string } }, options?: CallOptions): Promise<NextRunnable>
```

## kitOverview

A project's run overview

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

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

## kitPlanSync

Sync a plan into tasks

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/plan/sync`

```ts
kitPlanSync(args: { tenantId: string; projectId: string; body: PlanSyncRequest }, options?: CallOptions): Promise<PlanSyncResult>
```

## kitPolicyGet

Read a project's run policy

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

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

## kitPolicyPut

Set a project's run policy (policy class)

- Request: `PUT` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/policy`
- Needs an approval for agents: class `policy_change`

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

## kitReport

The morning report for a window

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

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

## kitReportDeliver

Put the morning report for the last report time in the team inbox, once

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/report/deliver`

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

## kitRunClaimNext

Claim the next runnable task under a run, in one step

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}/claim-next`

```ts
kitRunClaimNext(args: { tenantId: string; projectId: string; runId: string; body: ClaimNextRequest }, options?: CallOptions): Promise<ClaimNextResult>
```

## kitRunDecision

Record a decision in a run

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}/decisions`

```ts
kitRunDecision(args: { tenantId: string; projectId: string; runId: string; body: RecordDecisionRequest }, options?: CallOptions): Promise<AgentDecision>
```

## kitRunEnd

End a run

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}/end`

```ts
kitRunEnd(args: { tenantId: string; projectId: string; runId: string; body: EndRunRequest }, options?: CallOptions): Promise<RunRecord>
```

## kitRunGet

Read a run

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}`

```ts
kitRunGet(args: { tenantId: string; projectId: string; runId: string }, options?: CallOptions): Promise<RunRecord>
```

## kitRunPull

Open the pull request for a task the run claimed

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}/pull`

```ts
kitRunPull(args: { tenantId: string; projectId: string; runId: string; body: RunPullRequest }, options?: CallOptions): Promise<RunPullResult>
```

## kitRunsList

List runs

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

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

## kitRunsStart

Start a run

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

```ts
kitRunsStart(args: { tenantId: string; projectId: string; body: StartRunRequest }, options?: CallOptions): Promise<RunRecord>
```

## kitUsageEventsDelete

Delete the caller's loop usage events in a project

- Request: `DELETE` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/usage-events`

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

## kitUsageEventsList

The caller's loop usage events in a project

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/usage-events`

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

## kitUsagePolicyGet

A project's usage policy, the caller's own caps, the cap that applies and each client's eligibility

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/usage-policy`

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

## kitUsagePolicyProjectPut

Set a project's usage policy (policy class)

- Request: `PUT` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/usage-policy/project`
- Needs an approval for agents: class `policy_change`

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

## kitUsagePolicyUserPut

Set the caller's own usage caps and whether usage events may be shared

- Request: `PUT` on `/v1/tenants/{tenantId}/projects/{projectId}/kit/usage-policy/user`

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

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