> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devin.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# NotesClient

## Constructor

```typescript
NotesClient(options: BaseClientOptions): NotesClient
```

### Parameters

**options** `BaseClientOptions` *required*

### Returns

`NotesClient`

## Methods

### createNote()

```typescript
createNote(request: CreateNoteNotesRequest, requestOptions?: RequestOptions): HttpResponsePromise<KnowledgeNoteResponse>
```

Create a note for an organization.

```ts
await client.notes.createNote({
        org_id: "org-abc123def456",
        body: {
            body: "body",
            name: "name",
            trigger: "trigger"
        }
    })
```

#### Parameters

**request** `CreateNoteNotesRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<KnowledgeNoteResponse>`

### deleteNote()

```typescript
deleteNote(request: DeleteNoteNotesRequest, requestOptions?: RequestOptions): HttpResponsePromise<KnowledgeNoteResponse>
```

Delete a note for an organization.

```ts
await client.notes.deleteNote({
        org_id: "org-abc123def456",
        note_id: "note-abc123def456"
    })
```

#### Parameters

**request** `DeleteNoteNotesRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<KnowledgeNoteResponse>`

### getNote()

```typescript
getNote(request: GetNoteNotesRequest, requestOptions?: RequestOptions): HttpResponsePromise<KnowledgeNoteResponse>
```

Get a note by ID for an organization.

```ts
await client.notes.getNote({
        org_id: "org-abc123def456",
        note_id: "note-abc123def456"
    })
```

#### Parameters

**request** `GetNoteNotesRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<KnowledgeNoteResponse>`

### listFolders()

```typescript
listFolders(request: ListFoldersNotesRequest, requestOptions?: RequestOptions): HttpResponsePromise<FolderTreeResponse>
```

Return the full folder tree with per-folder note counts.

```ts
await client.notes.listFolders({
        org_id: "org-abc123def456"
    })
```

#### Parameters

**request** `ListFoldersNotesRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<FolderTreeResponse>`

### listNotes()

```typescript
listNotes(request: ListNotesNotesRequest, requestOptions?: RequestOptions): Promise<Page<KnowledgeNoteResponse, PaginatedResponseKnowledgeNoteResponse>>
```

List notes for an organization.

```ts
await client.notes.listNotes({
        org_id: "org-abc123def456"
    })
```

#### Parameters

**request** `ListNotesNotesRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`Promise<Page<KnowledgeNoteResponse, PaginatedResponseKnowledgeNoteResponse>>`

### updateNote()

```typescript
updateNote(request: UpdateNoteNotesRequest, requestOptions?: RequestOptions): HttpResponsePromise<KnowledgeNoteResponse>
```

Update a note for an organization.

```ts
await client.notes.updateNote({
        org_id: "org-abc123def456",
        note_id: "note-abc123def456",
        body: {
            body: "body",
            name: "name",
            trigger: "trigger"
        }
    })
```

#### Parameters

**request** `UpdateNoteNotesRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<KnowledgeNoteResponse>`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.