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

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

## intentBrief

Compile a task's content-addressed agent brief from a context manifest

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/intent/briefs/{taskId}`

```ts
intentBrief(args: { tenantId: string; projectId: string; taskId: string; body: BriefRequest }, options?: CallOptions): Promise<AgentBrief>
```

## intentGet

The project's current intent revision

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

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

## intentRevisionDecide

Accept (make current and apply to the affected tasks) or reject an intent revision

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/intent/revisions/{revision}/decision`

```ts
intentRevisionDecide(args: { tenantId: string; projectId: string; revision: string; body: DecideIntentRequest }, options?: CallOptions): Promise<IntentDecisionResult>
```

## intentRevisionGet

Read one intent revision, its status and its impact

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/intent/revisions/{revision}`

```ts
intentRevisionGet(args: { tenantId: string; projectId: string; revision: string }, options?: CallOptions): Promise<IntentRevisionView>
```

## intentRevisionsList

List intent revisions with their status, newest first

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

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

## intentRevisionsPropose

Propose an immutable intent revision against the current one

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

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

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