Notebook.export¶
Export this notebook.
Signature¶
export(format: str='pdf') -> dict[str, Any]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
format |
str |
no | 'pdf' |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
notebook_id |
path |
string |
yes | - |
Fields¶
Schema: NotebookExportSchema
| Field |
|---|
format |
Return shape¶
HTTP 201 — Created
Schema: NotebookExportResultSchema
| Field | Type | Required |
|---|---|---|
dataset_id |
string |
yes |
dataset_title |
string |
yes |
file_count |
integer |
yes |
trace_count |
integer |
yes |
Permission¶
Required permission: notebook:read
HTTP¶
POST /api/notebooks/{id}/export (exportNotebook)
Usage¶
notebook.export()