Project.create_notebook¶
Create a notebook in this project.
Signature¶
create_notebook(title: str, **kwargs: Any) -> Notebook
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
title |
str |
yes | - |
**kwargs |
Any |
no | - |
Fields¶
Schema: NotebookCreateSchema
| Field | Type | Required |
|---|---|---|
description |
string |
no |
primary_dataset_id |
string |
no |
project_id |
string |
yes |
title |
string |
yes |
Return shape¶
HTTP 201 — Created
Schema: NotebookSchema
| Field | Type | Required |
|---|---|---|
created_at |
string |
no |
description |
string |
yes |
id |
string |
yes |
primary_dataset_id |
string |
no |
project_id |
string |
yes |
slug |
string |
no |
slug_number |
integer |
no |
tags |
array<NotebookTagSchema> |
no |
title |
string |
yes |
trace_count |
integer |
no |
updated_at |
string |
no |
Permission¶
Required permission: notebook:create
HTTP¶
POST /api/notebooks/ (createNotebook)
Usage¶
project.create_notebook(title)