Skip to content

Notebooks

albert.collections.notebooks

NotebookBlock module-attribute 

NotebookBlock = Annotated[
    _NotebookBlockUnion, Field(discriminator="type")
]

AlbertException 

AlbertException(message: str)

Bases: Exception

Source code in src/albert/exceptions.py 
10
11
12
def __init__(self, message: str):
    super().__init__(message)
    self.message = message

message instance-attribute 

message = message

AlbertSession 

AlbertSession(
    *,
    base_url: str,
    token: str | None = None,
    auth_manager: AlbertClientCredentials
    | AlbertSSOClient
    | None = None,
    retries: int | None = None,
)

Bases: Session

A session that has a base URL, which is prefixed to all request URLs.

Parameters:

Name Type Description Default
base_url str

The base URL to prefix to all relative request paths (e.g., "https://app.albertinvent.com").

 required
token str | None

A static JWT token for authentication. Ignored if auth_manager is provided.

 None
auth_manager AlbertClientCredentials | AlbertSSOClient

An authentication manager used to dynamically fetch and refresh tokens. If provided, it overrides token.

 None
retries int

The number of automatic retries on failed requests (default is 3).

 None

Methods:

Name Description
request
Source code in src/albert/core/session.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def __init__(
    self,
    *,
    base_url: str,
    token: str | None = None,
    auth_manager: AlbertClientCredentials | AlbertSSOClient | None = None,
    retries: int | None = None,
):
    super().__init__()
    self.base_url = base_url
    self.headers.update(
        {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "User-Agent": f"albert-SDK V.{albert.__version__}",
        }
    )

    if token is None and auth_manager is None:
        raise ValueError("Either `token` or `auth_manager` must be specified.")

    self._auth_manager = auth_manager
    self._provided_token = token

    # Set up retry logic
    retries = retries if retries is not None else 3
    retry = Retry(
        total=retries,
        read=retries,
        connect=retries,
        backoff_factor=0.3,
        status_forcelist=(500, 502, 503, 504, 403),
        raise_on_status=False,
    )
    adapter = HTTPAdapter(max_retries=retry)
    self.mount("http://", adapter)
    self.mount("https://", adapter)

base_url instance-attribute 

base_url = base_url

request 

request(
    method: str, path: str, *args, **kwargs
) -> Response
Source code in src/albert/core/session.py 
75
76
77
78
79
80
81
def request(self, method: str, path: str, *args, **kwargs) -> requests.Response:
    self.headers["Authorization"] = f"Bearer {self._access_token}"
    full_url = urljoin(self.base_url, path) if not path.startswith("http") else path
    with handle_http_errors():
        response = super().request(method, full_url, *args, **kwargs)
        response.raise_for_status()
        return response

BaseCollection 

BaseCollection(*, session: AlbertSession)

BaseCollection is the base class for all collection classes.

Parameters:

Name Type Description Default
session AlbertSession

The Albert API Session instance.

 required
Source code in src/albert/collections/base.py 
21
22
def __init__(self, *, session: AlbertSession):
    self.session = session

session instance-attribute 

session = session

NotFoundError 

NotFoundError(response: Response)

Bases: AlbertClientError

HTTP Error due to a 404 Not Found response.

Source code in src/albert/exceptions.py 
18
19
20
21
def __init__(self, response: requests.Response):
    message = self._format_message(response)
    super().__init__(message)
    self.response = response

Notebook

Bases: BaseResource

blocks class-attribute instance-attribute 

blocks: list[NotebookBlock] = Field(default_factory=list)

id class-attribute instance-attribute 

id: NotebookId | None = Field(
    default=None, alias="albertId"
)

links: list[NotebookLink] | None = Field(default=None)

name class-attribute instance-attribute 

name: str = Field(default='Untitled Notebook')

parent_id class-attribute instance-attribute 

parent_id: ProjectId | TaskId = Field(..., alias="parentId")

version class-attribute instance-attribute 

version: datetime | None = Field(default=None)

NotebookCollection 

NotebookCollection(*, session: AlbertSession)

Bases: BaseCollection

NotebookCollection is a collection class for managing Notebook entities in the Albert platform.

Parameters:

Name Type Description Default
session AlbertSession

The Albert session instance.

 required

Methods:

Name Description
copy

Create a copy of a Notebook into a specified parent
create

Create or return notebook for the provided notebook.
delete

Deletes a notebook by its ID.
get_block_by_id

Retrieve a Notebook Block by its ID.
get_by_id

Retrieve a Notebook by its ID.
list_by_parent_id

Retrieve a Notebook by parent ID.
update

Update a notebook.
update_block_content

Updates the block content of a Notebook. This does not update the notebook name (use .update for that).
Source code in src/albert/collections/notebooks.py 
23
24
25
26
27
28
29
30
31
32
33
def __init__(self, *, session: AlbertSession):
    """
    Initializes the NotebookCollection with the provided session.

    Parameters
    ----------
    session : AlbertSession
        The Albert session instance.
    """
    super().__init__(session=session)
    self.base_path = f"/api/{NotebookCollection._api_version}/notebooks"

base_path instance-attribute 

base_path = f'/api/{_api_version}/notebooks'

copy 

copy(
    *,
    notebook_copy_info: NotebookCopyInfo,
    type: NotebookCopyType,
) -> Notebook

Create a copy of a Notebook into a specified parent

Parameters:

Name Type Description Default
notebook_copy_info NotebookCopyInfo

The copy information for the Notebook copy

 required
type NotebookCopyType

Differentiate whether copy is for templates, task, project or restoreTemplate

 required

Returns:

Type Description
Notebook

The result of the copied Notebook.
Source code in src/albert/collections/notebooks.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
def copy(self, *, notebook_copy_info: NotebookCopyInfo, type: NotebookCopyType) -> Notebook:
    """Create a copy of a Notebook into a specified parent

    Parameters
    ----------
    notebook_copy_info : NotebookCopyInfo
        The copy information for the Notebook copy
    type : NotebookCopyType
        Differentiate whether copy is for templates, task, project or restoreTemplate

    Returns
    -------
    Notebook
        The result of the copied Notebook.
    """
    response = self.session.post(
        url=f"{self.base_path}/copy",
        json=notebook_copy_info.model_dump(mode="json", by_alias=True, exclude_none=True),
        params={"type": type, "parentId": notebook_copy_info.parent_id},
    )
    return Notebook(**response.json())

create 

create(*, notebook: Notebook) -> Notebook

Create or return notebook for the provided notebook. This endpoint automatically tries to find an existing notebook with the same parameter setpoints, and will either return the existing notebook or create a new one.

Parameters:

Name Type Description Default
notebook Notebook

A list of Notebook objects to find or create.

 required

Returns:

Type Description
Notebook

A list of created or found Notebook objects.
Source code in src/albert/collections/notebooks.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def create(self, *, notebook: Notebook) -> Notebook:
    """Create or return notebook for the provided notebook.
    This endpoint automatically tries to find an existing notebook with the same parameter setpoints, and will either return the existing notebook or create a new one.

    Parameters
    ----------
    notebook : Notebook
        A list of Notebook objects to find or create.

    Returns
    -------
    Notebook
        A list of created or found Notebook objects.
    """
    if notebook.blocks:
        # This check keeps a user from corrupting the Notebook data.
        msg = (
            "Cannot create a Notebook with pre-filled blocks. "
            "Set `blocks=[]` (or do not set it) when creating it. "
            "Use `.update_block_content()` afterward to add, update, or delete blocks."
        )
        raise AlbertException(msg)
    response = self.session.post(
        url=self.base_path,
        json=notebook.model_dump(mode="json", by_alias=True, exclude_none=True),
        params={"parentId": notebook.parent_id},
    )
    return Notebook(**response.json())

delete 

delete(*, id: str) -> None

Deletes a notebook by its ID.

Parameters:

Name Type Description Default
id str

The ID of the notebook to delete.

 required
Source code in src/albert/collections/notebooks.py 
100
101
102
103
104
105
106
107
108
109
def delete(self, *, id: str) -> None:
    """
    Deletes a notebook by its ID.

    Parameters
    ----------
    id : str
        The ID of the notebook to delete.
    """
    self.session.delete(f"{self.base_path}/{id}")

get_block_by_id 

get_block_by_id(
    *, notebook_id: str, block_id: str
) -> NotebookBlock

Retrieve a Notebook Block by its ID.

Parameters:

Name Type Description Default
notebook_id str

The ID of the Notebook to which the Block belongs.

 required
block_id str

The ID of the Notebook Block to retrieve.

 required

Returns:

Type Description
NotebookBlock

The NotebookBlock object.
Source code in src/albert/collections/notebooks.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
def get_block_by_id(self, *, notebook_id: str, block_id: str) -> NotebookBlock:
    """Retrieve a Notebook Block by its ID.

    Parameters
    ----------
    notebook_id : str
        The ID of the Notebook to which the Block belongs.
    block_id : str
        The ID of the Notebook Block to retrieve.

    Returns
    -------
    NotebookBlock
        The NotebookBlock object.
    """
    response = self.session.get(f"{self.base_path}/{notebook_id}/blocks/{block_id}")
    return TypeAdapter(NotebookBlock).validate_python(response.json())

get_by_id 

get_by_id(*, id: str) -> Notebook

Retrieve a Notebook by its ID.

Parameters:

Name Type Description Default
id str

The ID of the Notebook to retrieve.

 required

Returns:

Type Description
Notebook

The Notebook object.
Source code in src/albert/collections/notebooks.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def get_by_id(self, *, id: str) -> Notebook:
    """Retrieve a Notebook by its ID.

    Parameters
    ----------
    id : str
        The ID of the Notebook to retrieve.

    Returns
    -------
    Notebook
        The Notebook object.
    """
    response = self.session.get(f"{self.base_path}/{id}")
    return Notebook(**response.json())

list_by_parent_id 

list_by_parent_id(*, parent_id: str) -> list[Notebook]

Retrieve a Notebook by parent ID.

Parameters:

Name Type Description Default
parent_id str

The ID of the parent ID, e.g. task.

 required

Returns:

Type Description
list[Notebook]

list of notebook references.
Source code in src/albert/collections/notebooks.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def list_by_parent_id(self, *, parent_id: str) -> list[Notebook]:
    """Retrieve a Notebook by parent ID.

    Parameters
    ----------
    parent_id : str
        The ID of the parent ID, e.g. task.

    Returns
    -------
    list[Notebook]
        list of notebook references.

    """

    # search
    response = self.session.get(f"{self.base_path}/{parent_id}/search")
    # return
    return [self.get_by_id(id=x["id"]) for x in response.json()["Items"]]

update 

update(*, notebook: Notebook) -> Notebook

Update a notebook.

Parameters:

Name Type Description Default
notebook Notebook

The updated notebook object.

 required

Returns:

Type Description
Notebook

The updated notebook object as returned by the server.
Source code in src/albert/collections/notebooks.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def update(self, *, notebook: Notebook) -> Notebook:
    """Update a notebook.

    Parameters
    ----------
    notebook : Notebook
        The updated notebook object.

    Returns
    -------
    Notebook
        The updated notebook object as returned by the server.
    """
    existing_notebook = self.get_by_id(id=notebook.id)
    patch_data = self._generate_patch_payload(existing=existing_notebook, updated=notebook)
    url = f"{self.base_path}/{notebook.id}"

    self.session.patch(url, json=patch_data.model_dump(mode="json", by_alias=True))

    return self.get_by_id(id=notebook.id)

update_block_content 

update_block_content(*, notebook: Notebook) -> Notebook

Updates the block content of a Notebook. This does not update the notebook name (use .update for that). If a block in the Notebook does not already exist on Albert, it will be created. Note: The order of the Blocks in your Notebook matter and will be used in the updated Notebook!

Parameters:

Name Type Description Default
notebook Notebook

The updated notebook object.

 required

Returns:

Type Description
Notebook

The updated notebook object as returned by the server.
Source code in src/albert/collections/notebooks.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def update_block_content(self, *, notebook: Notebook) -> Notebook:
    """
    Updates the block content of a Notebook. This does not update the notebook name (use .update for that).
    If a block in the Notebook does not already exist on Albert, it will be created.
    *Note: The order of the Blocks in your Notebook matter and will be used in the updated Notebook!*


    Parameters
    ----------
    notebook : Notebook
        The updated notebook object.

    Returns
    -------
    Notebook
        The updated notebook object as returned by the server.
    """
    put_data = self._generate_put_block_payload(notebook=notebook)
    url = f"{self.base_path}/{notebook.id}/content"

    self.session.put(url, json=put_data.model_dump(mode="json", by_alias=True))

    return self.get_by_id(id=notebook.id)

NotebookCopyInfo pydantic-model

Bases: BaseAlbertModel

Show JSON schema: 
{
  "$defs": {
    "ACL": {
      "description": "The Access Control List (ACL) for a user",
      "properties": {
        "id": {
          "description": "The id of the user for which this ACL applies",
          "title": "Id",
          "type": "string"
        },
        "fgc": {
          "anyOf": [
            {
              "$ref": "#/$defs/AccessControlLevel"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "The Fine-Grain Control Level"
        }
      },
      "required": [
        "id"
      ],
      "title": "ACL",
      "type": "object"
    },
    "AccessControlLevel": {
      "description": "The fine grain control",
      "enum": [
        "ProjectOwner",
        "ProjectEditor",
        "ProjectViewer",
        "ProjectAllTask",
        "ProjectPropertyTask",
        "InventoryOwner",
        "InventoryViewer",
        "CustomTemplateOwner",
        "CustomTemplateViewer"
      ],
      "title": "AccessControlLevel",
      "type": "string"
    },
    "AuditFields": {
      "description": "The audit fields for a resource",
      "properties": {
        "by": {
          "default": null,
          "title": "By",
          "type": "string"
        },
        "byName": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Byname"
        },
        "at": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "At"
        }
      },
      "title": "AuditFields",
      "type": "object"
    },
    "NotebookCopyACL": {
      "properties": {
        "status": {
          "anyOf": [
            {
              "$ref": "#/$defs/Status"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        },
        "Created": {
          "anyOf": [
            {
              "$ref": "#/$defs/AuditFields"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        },
        "Updated": {
          "anyOf": [
            {
              "$ref": "#/$defs/AuditFields"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        },
        "fgclist": {
          "default": null,
          "items": {
            "$ref": "#/$defs/ACL"
          },
          "title": "Fgclist",
          "type": "array"
        },
        "class": {
          "title": "Class",
          "type": "string"
        }
      },
      "required": [
        "class"
      ],
      "title": "NotebookCopyACL",
      "type": "object"
    },
    "Status": {
      "description": "The status of a resource",
      "enum": [
        "active",
        "inactive"
      ],
      "title": "Status",
      "type": "string"
    }
  },
  "properties": {
    "id": {
      "title": "Id",
      "type": "string"
    },
    "parentId": {
      "title": "Parentid",
      "type": "string"
    },
    "notebookName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Notebookname"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "acl": {
      "anyOf": [
        {
          "$ref": "#/$defs/NotebookCopyACL"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "id",
    "parentId"
  ],
  "title": "NotebookCopyInfo",
  "type": "object"
}

Fields:

acl pydantic-field 

acl: NotebookCopyACL | None = None

id pydantic-field 

id: NotebookId

name pydantic-field 

name: str | None = None

notebook_name pydantic-field 

notebook_name: str | None = None

parent_id pydantic-field 

parent_id: str

NotebookCopyType

Bases: str, Enum

GEN_TASK_TEMPLATE class-attribute instance-attribute 

GEN_TASK_TEMPLATE = 'genTaskTemplate'

PROJECT class-attribute instance-attribute 

PROJECT = 'Project'

RESTORE_TEMPLATE class-attribute instance-attribute 

RESTORE_TEMPLATE = 'restoreTemplate'

TASK class-attribute instance-attribute 

TASK = 'Task'

TEMPLATE class-attribute instance-attribute 

TEMPLATE = 'template'

PutBlockDatum pydantic-model

Bases: BaseAlbertModel

Show JSON schema: 
{
  "$defs": {
    "AttachesContent": {
      "properties": {
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "namespace": {
          "default": "result",
          "title": "Namespace",
          "type": "string"
        },
        "fileKey": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filekey"
        },
        "mimeType": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mimetype"
        },
        "signedURL": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Signedurl"
        }
      },
      "title": "AttachesContent",
      "type": "object"
    },
    "BlockType": {
      "enum": [
        "paragraph",
        "list",
        "header",
        "checklist",
        "image",
        "attaches",
        "ketcher",
        "table"
      ],
      "title": "BlockType",
      "type": "string"
    },
    "BulletedListContent": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/NotebookListItem"
          },
          "title": "Items",
          "type": "array"
        },
        "style": {
          "const": "unordered",
          "default": "unordered",
          "title": "Style",
          "type": "string"
        }
      },
      "required": [
        "items"
      ],
      "title": "BulletedListContent",
      "type": "object"
    },
    "ChecklistContent": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ChecklistItem"
          },
          "title": "Items",
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "title": "ChecklistContent",
      "type": "object"
    },
    "ChecklistItem": {
      "properties": {
        "checked": {
          "title": "Checked",
          "type": "boolean"
        },
        "text": {
          "title": "Text",
          "type": "string"
        }
      },
      "required": [
        "checked",
        "text"
      ],
      "title": "ChecklistItem",
      "type": "object"
    },
    "HeaderContent": {
      "properties": {
        "level": {
          "enum": [
            1,
            2,
            3
          ],
          "title": "Level",
          "type": "integer"
        },
        "text": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Text"
        }
      },
      "required": [
        "level",
        "text"
      ],
      "title": "HeaderContent",
      "type": "object"
    },
    "ImageContent": {
      "properties": {
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "namespace": {
          "default": "result",
          "title": "Namespace",
          "type": "string"
        },
        "stretched": {
          "default": false,
          "title": "Stretched",
          "type": "boolean"
        },
        "withBackground": {
          "default": false,
          "title": "Withbackground",
          "type": "boolean"
        },
        "withBorder": {
          "default": false,
          "title": "Withborder",
          "type": "boolean"
        },
        "fileKey": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filekey"
        },
        "signedURL": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Signedurl"
        }
      },
      "title": "ImageContent",
      "type": "object"
    },
    "KetcherContent": {
      "properties": {
        "synthesisId": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Synthesisid"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "blockId": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Blockid"
        },
        "data": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        },
        "fileKey": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filekey"
        },
        "s3Key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "S3Key"
        },
        "png": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Png"
        },
        "ketcherUrl": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Ketcherurl"
        }
      },
      "title": "KetcherContent",
      "type": "object"
    },
    "NotebookListItem": {
      "properties": {
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Content"
        },
        "items": {
          "items": {
            "$ref": "#/$defs/NotebookListItem"
          },
          "title": "Items",
          "type": "array"
        }
      },
      "required": [
        "content"
      ],
      "title": "NotebookListItem",
      "type": "object"
    },
    "NumberedListContent": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/NotebookListItem"
          },
          "title": "Items",
          "type": "array"
        },
        "style": {
          "const": "ordered",
          "default": "ordered",
          "title": "Style",
          "type": "string"
        }
      },
      "required": [
        "items"
      ],
      "title": "NumberedListContent",
      "type": "object"
    },
    "ParagraphContent": {
      "properties": {
        "text": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Text"
        }
      },
      "required": [
        "text"
      ],
      "title": "ParagraphContent",
      "type": "object"
    },
    "PutOperation": {
      "enum": [
        "update",
        "delete"
      ],
      "title": "PutOperation",
      "type": "string"
    },
    "TableContent": {
      "properties": {
        "content": {
          "items": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "type": "array"
          },
          "title": "Content",
          "type": "array"
        },
        "withHeadings": {
          "default": false,
          "title": "Withheadings",
          "type": "boolean"
        }
      },
      "required": [
        "content"
      ],
      "title": "TableContent",
      "type": "object"
    }
  },
  "properties": {
    "id": {
      "title": "Id",
      "type": "string"
    },
    "operation": {
      "$ref": "#/$defs/PutOperation"
    },
    "blockType": {
      "anyOf": [
        {
          "$ref": "#/$defs/BlockType"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "content": {
      "anyOf": [
        {
          "$ref": "#/$defs/HeaderContent"
        },
        {
          "$ref": "#/$defs/ParagraphContent"
        },
        {
          "$ref": "#/$defs/ChecklistContent"
        },
        {
          "$ref": "#/$defs/AttachesContent"
        },
        {
          "$ref": "#/$defs/ImageContent"
        },
        {
          "$ref": "#/$defs/KetcherContent"
        },
        {
          "$ref": "#/$defs/TableContent"
        },
        {
          "$ref": "#/$defs/BulletedListContent"
        },
        {
          "$ref": "#/$defs/NumberedListContent"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Content"
    },
    "previousBlockId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Previousblockid"
    }
  },
  "required": [
    "id",
    "operation"
  ],
  "title": "PutBlockDatum",
  "type": "object"
}

Fields:

Validators:

content pydantic-field 

content: NotebookContent | None = None

id pydantic-field 

id: str

operation pydantic-field 

operation: PutOperation

previous_block_id pydantic-field 

previous_block_id: str | None = None

type pydantic-field 

type: BlockType | None = None

content_matches_type pydantic-validator 

content_matches_type() -> PutBlockDatum
Source code in src/albert/resources/notebooks.py 
265
266
267
268
269
270
271
272
273
274
@model_validator(mode="after")
def content_matches_type(self) -> "PutBlockDatum":
    if self.content is None:
        return self  # skip check if there's no content

    content_type = allowed_notebook_contents.get(self.type)
    if content_type and not isinstance(self.content, content_type):
        msg = f"The content type and block type do not match. [content_type={type(self.content)}, block_type={self.type}]"
        raise AlbertException(msg)
    return self

model_dump 

model_dump(**kwargs) -> dict[str, Any]

Shallow model_dump to exclude None values (None only removed from top level). This ensures required attrs are not removed.

Source code in src/albert/resources/notebooks.py 
276
277
278
279
280
281
282
def model_dump(self, **kwargs) -> dict[str, Any]:
    """
    Shallow model_dump to exclude None values (None only removed from top level).
    This ensures required attrs are not removed.
    """
    base = super().model_dump(**kwargs)
    return {k: v for k, v in base.items() if v is not None}

PutBlockPayload pydantic-model

Bases: BaseAlbertModel

Show JSON schema: 
{
  "$defs": {
    "AttachesContent": {
      "properties": {
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "namespace": {
          "default": "result",
          "title": "Namespace",
          "type": "string"
        },
        "fileKey": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filekey"
        },
        "mimeType": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mimetype"
        },
        "signedURL": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Signedurl"
        }
      },
      "title": "AttachesContent",
      "type": "object"
    },
    "BlockType": {
      "enum": [
        "paragraph",
        "list",
        "header",
        "checklist",
        "image",
        "attaches",
        "ketcher",
        "table"
      ],
      "title": "BlockType",
      "type": "string"
    },
    "BulletedListContent": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/NotebookListItem"
          },
          "title": "Items",
          "type": "array"
        },
        "style": {
          "const": "unordered",
          "default": "unordered",
          "title": "Style",
          "type": "string"
        }
      },
      "required": [
        "items"
      ],
      "title": "BulletedListContent",
      "type": "object"
    },
    "ChecklistContent": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ChecklistItem"
          },
          "title": "Items",
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "title": "ChecklistContent",
      "type": "object"
    },
    "ChecklistItem": {
      "properties": {
        "checked": {
          "title": "Checked",
          "type": "boolean"
        },
        "text": {
          "title": "Text",
          "type": "string"
        }
      },
      "required": [
        "checked",
        "text"
      ],
      "title": "ChecklistItem",
      "type": "object"
    },
    "HeaderContent": {
      "properties": {
        "level": {
          "enum": [
            1,
            2,
            3
          ],
          "title": "Level",
          "type": "integer"
        },
        "text": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Text"
        }
      },
      "required": [
        "level",
        "text"
      ],
      "title": "HeaderContent",
      "type": "object"
    },
    "ImageContent": {
      "properties": {
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "namespace": {
          "default": "result",
          "title": "Namespace",
          "type": "string"
        },
        "stretched": {
          "default": false,
          "title": "Stretched",
          "type": "boolean"
        },
        "withBackground": {
          "default": false,
          "title": "Withbackground",
          "type": "boolean"
        },
        "withBorder": {
          "default": false,
          "title": "Withborder",
          "type": "boolean"
        },
        "fileKey": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filekey"
        },
        "signedURL": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Signedurl"
        }
      },
      "title": "ImageContent",
      "type": "object"
    },
    "KetcherContent": {
      "properties": {
        "synthesisId": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Synthesisid"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "blockId": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Blockid"
        },
        "data": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        },
        "fileKey": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filekey"
        },
        "s3Key": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "S3Key"
        },
        "png": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Png"
        },
        "ketcherUrl": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Ketcherurl"
        }
      },
      "title": "KetcherContent",
      "type": "object"
    },
    "NotebookListItem": {
      "properties": {
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Content"
        },
        "items": {
          "items": {
            "$ref": "#/$defs/NotebookListItem"
          },
          "title": "Items",
          "type": "array"
        }
      },
      "required": [
        "content"
      ],
      "title": "NotebookListItem",
      "type": "object"
    },
    "NumberedListContent": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/NotebookListItem"
          },
          "title": "Items",
          "type": "array"
        },
        "style": {
          "const": "ordered",
          "default": "ordered",
          "title": "Style",
          "type": "string"
        }
      },
      "required": [
        "items"
      ],
      "title": "NumberedListContent",
      "type": "object"
    },
    "ParagraphContent": {
      "properties": {
        "text": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Text"
        }
      },
      "required": [
        "text"
      ],
      "title": "ParagraphContent",
      "type": "object"
    },
    "PutBlockDatum": {
      "properties": {
        "id": {
          "title": "Id",
          "type": "string"
        },
        "operation": {
          "$ref": "#/$defs/PutOperation"
        },
        "blockType": {
          "anyOf": [
            {
              "$ref": "#/$defs/BlockType"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        },
        "content": {
          "anyOf": [
            {
              "$ref": "#/$defs/HeaderContent"
            },
            {
              "$ref": "#/$defs/ParagraphContent"
            },
            {
              "$ref": "#/$defs/ChecklistContent"
            },
            {
              "$ref": "#/$defs/AttachesContent"
            },
            {
              "$ref": "#/$defs/ImageContent"
            },
            {
              "$ref": "#/$defs/KetcherContent"
            },
            {
              "$ref": "#/$defs/TableContent"
            },
            {
              "$ref": "#/$defs/BulletedListContent"
            },
            {
              "$ref": "#/$defs/NumberedListContent"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Content"
        },
        "previousBlockId": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Previousblockid"
        }
      },
      "required": [
        "id",
        "operation"
      ],
      "title": "PutBlockDatum",
      "type": "object"
    },
    "PutOperation": {
      "enum": [
        "update",
        "delete"
      ],
      "title": "PutOperation",
      "type": "string"
    },
    "TableContent": {
      "properties": {
        "content": {
          "items": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "type": "array"
          },
          "title": "Content",
          "type": "array"
        },
        "withHeadings": {
          "default": false,
          "title": "Withheadings",
          "type": "boolean"
        }
      },
      "required": [
        "content"
      ],
      "title": "TableContent",
      "type": "object"
    }
  },
  "properties": {
    "data": {
      "items": {
        "$ref": "#/$defs/PutBlockDatum"
      },
      "title": "Data",
      "type": "array"
    }
  },
  "required": [
    "data"
  ],
  "title": "PutBlockPayload",
  "type": "object"
}

Fields:

data pydantic-field 

data: list[PutBlockDatum]

model_dump 

model_dump(**kwargs) -> dict[str, Any]

model_dump to ensure only top-level None attrs are removed on PutBlockDatum.

Source code in src/albert/resources/notebooks.py 
288
289
290
def model_dump(self, **kwargs) -> dict[str, Any]:
    """model_dump to ensure only top-level None attrs are removed on PutBlockDatum."""
    return {"data": [item.model_dump(**kwargs) for item in self.data]}

PutOperation

Bases: str, Enum

DELETE class-attribute instance-attribute 

DELETE = 'delete'

UPDATE class-attribute instance-attribute 

UPDATE = 'update'