Skip to content

SDK: intent

The intent methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types.

Updated View as MarkdownOpen in ChatGPTOpen in Claude

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).

intentBrief

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

  • Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/intent/briefs/{taskId}
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
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
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}
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
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
intentRevisionsPropose(args: { tenantId: string; projectId: string; body: ProposeIntentRequest }, options?: CallOptions): Promise<IntentRevisionView>
Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.