---
title: "Update notebook readme content directly"
method: PATCH
path: "/api/notebooks/{notebook}/readme-content"
tags: ["notebook-controller"]
---

# Update notebook readme content directly

`PATCH /api/notebooks/{notebook}/readme-content`

## Request

- Base URL: `` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/notebooks/{notebook}/readme-content`
- Auth: none declared

Saves the given markdown (with optional YAML frontmatter) as the notebook container's readmeContent field. Blank content clears the field.

## Path parameters

- `notebook` integer, required

## Request body

- NoteUpdateContentDTO
  - `content` string

## Response `200`

OK

- NotebookRealm: Notebook chrome: entity plus optional catalog hints (attached book, readonly), and optional container-owned readme markdown.
  - `notebook` Notebook, required
    - `id` integer, required
    - `notebookSettings` NotebookSettings, required
      - `skipMemoryTrackingEntirely` boolean
    - `creatorId` string
    - `name` string, required
    - `circle` Circle
      - `id` integer, required
      - `name` string, required
    - `description` string
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `readmeContent` string
  - `hasAttachedBook` boolean
  - `readonly` boolean
  - `readmeContent` string: Container-owned notebook readme markdown. Omitted when absent.

## Changes

- **2026-07-22** `13f77438750e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nerds-odd-e/apis/odd-e-open-api/changes/api/notebooks/:notebook/readme-content/patch.md)

---

[API](https://skmtc.dev/nerds-odd-e/apis/odd-e-open-api.md) - [All operations](https://skmtc.dev/nerds-odd-e/apis/odd-e-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nerds-odd-e/apis/odd-e-open-api/revisions/193c5e89085a?raw)