Notebook.add_note¶
Add a note to this notebook.
Signature¶
add_note(content: str) -> dict[str, Any]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
content |
str |
yes | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
notebook_id |
path |
string |
yes | - |
Fields¶
Schema: NotebookNoteCreateSchema
| Field |
|---|
content |
Return shape¶
HTTP 201 — Created
Schema: NoteSchema
| Field | Type | Required |
|---|---|---|
author_id |
string |
no |
author_name |
string |
no |
content |
string |
yes |
created_at |
string |
no |
dataset_id |
string |
no |
id |
string |
yes |
notebook_id |
string |
no |
project_id |
string |
no |
updated_at |
string |
no |
Permission¶
Required permission: notebook:update
HTTP¶
POST /api/notebooks/{id}/notes/ (createNotebookNote)
Usage¶
notebook.add_note(content)