Notesclub

created by hec & contributors

terms privacy

Domain Documentation

livebook.livemd

nocsi

@nocsi

drip_api

Share to X

Share to Bluesky

More notebooks

Domain Documentation

Domain Kyozo.Accounts

Class Diagram

classDiagram
    class Token {
        String jti
        String subject
        UtcDatetime expires_at
        String purpose
        Map extra_data
        store_confirmation_changes(String token, Map extra_data, String purpose)
        get_confirmation_changes(String jti)
        read_expired()
        read()
        expired()
        get_token(String token, String jti, String purpose)
        revoked?(String token, String jti)
        revoke_token(String token, Map extra_data)
        revoke_jti(String subject, String jti, Map extra_data)
        store_token(String token, Map extra_data, String purpose)
        expunge_expired()
        revoke_all_stored_for_subject(String subject, Map extra_data)
    }
    class Team {
        UUIDv7 id
        String name
        String domain
        String description
        destroy()
        read()
        create(String name, String domain, String description)
        list_user_teams()
        update_team(String name, String domain, String description)
    }
    class UserTeam {
        UUIDv7 id
        String role
        UUID user_id
        UUID team_id
        User user
        Team team
        destroy()
        update(UUID user_id, UUID team_id)
        read()
        create(UUID user_id, UUID team_id)
        list_team_members()
        add_team_member(UUID user_id, String role)
        change_member_role(String role)
        remove_team_member()
        leave_team()
        is_member?(String user_id)
    }
    class Invitation {
        UUIDv7 id
        UUID invited_user_id
        UUID inviter_user_id
        UUID team_id
        User invited_user
        User inviter_user
        Team team
        read()
        list_received_invitations()
        list_invitations_sent()
        invite_user(UUID invited_user_id)
        cancel_invitation()
        decline_invitation()
        accept_invitation()
    }
    class Group {
        UUIDv7 id
        destroy()
        update(String name, String description)
        read()
        create(String name, String description)
    }
    class GroupPermission {
        UUIDv7 id
        destroy()
        update(String resource, String action, UUID group_id)
        read()
        create(String resource, String action, UUID group_id)
    }
    class UserGroup {
        UUIDv7 id
        destroy()
        update(UUID user_id, UUID group_id)
        read()
        create(UUID user_id, UUID group_id)
    }
    class User {
        UUIDv7 id
        String name
        CiString email
        String picture
        confirm(String confirm, CiString email)
        log_out_everywhere(Struct user)
        update()
        read()
        destroy()
        current_user()
        set_current_team(String team)
        get_by_subject(String subject)
        change_password(String current_password, String password, String password_confirmation)
        sign_in_with_password(CiString email, String password)
        sign_in_with_token(String token)
        register_with_password(String name, CiString email, String password, String password_confirmation)
        request_password_reset_token(CiString email)
        get_by_email(CiString email)
        reset_password_with_token(String reset_token, String password, String password_confirmation)
        search_users(String search)
        sign_in_with_api_key(String api_key)
    }
    class UserIdentity {
        String strategy
        read()
        destroy()
        upsert(Map user_info, Map oauth_tokens, UUIDv7 user_id, String strategy)
    }
    class Notification {
        UUID id
        destroy()
        update(UUID sender_user_id, UUID recipient_user_id, String subject, String body, ...)
        create(UUID sender_user_id, UUID recipient_user_id, String subject, String body, ...)
        read()
        send(UUID sender_user_id, UUID recipient_user_id, String subject, String body, ...)
        unprocessed()
        for_user()
    }
    class ApiKey {
        UUID id
        destroy()
        read()
        create(UUID user_id, UtcDatetimeUsec expires_at)
    }

    ApiKey -- User
    Group -- GroupPermission
    Group -- User
    Group -- UserGroup
    Invitation -- Team
    Invitation -- User
    Notification -- User
    Team -- User
    Team -- UserTeam
    User -- UserGroup
    User -- UserIdentity
    User -- UserTeam

ER Diagram

erDiagram
    "Token" {
        String jti
        String subject
        UtcDatetime expires_at
        String purpose
        Map extra_data
    }
    "Team" {
        UUIDv7 id
        String name
        String domain
        String description
    }
    "UserTeam" {
        UUIDv7 id
        String role
        UUID user_id
        UUID team_id
    }
    "Invitation" {
        UUIDv7 id
        UUID invited_user_id
        UUID inviter_user_id
        UUID team_id
    }
    "Group" {
        UUIDv7 id
    }
    "GroupPermission" {
        UUIDv7 id
    }
    "UserGroup" {
        UUIDv7 id
    }
    "User" {
        UUIDv7 id
        String name
        CiString email
        String picture
    }
    "UserIdentity" {
        String strategy
    }
    "Notification" {
        UUID id
    }
    "ApiKey" {
        UUID id
    }

    "ApiKey" ||--|| "User" : ""
    "Group" ||--|| "GroupPermission" : ""
    "Group" ||--|| "User" : ""
    "Group" ||--|| "UserGroup" : ""
    "Invitation" ||--|| "Team" : ""
    "Invitation" ||--|| "User" : ""
    "Notification" ||--|| "User" : ""
    "Team" ||--|| "User" : ""
    "Team" ||--|| "UserTeam" : ""
    "User" ||--|| "UserGroup" : ""
    "User" ||--|| "UserIdentity" : ""
    "User" ||--|| "UserTeam" : ""

Resources

Token
Team
UserTeam
Invitation
Group
GroupPermission
UserGroup
User
UserIdentity
Notification
ApiKey

Token

Attributes

Name	Type	Description
jti	String
subject	String
expires_at	UtcDatetime
purpose	String
extra_data	Map
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec

Actions

Name	Type	Input	Description
store_confirmation_changes	create	token String extra_data Map attribute purpose String attribute
get_confirmation_changes	read	jti String
read_expired	read
read	read
expired	read		Look up all expired tokens.
get_token	read	token String jti String purpose String	Look up a token by JTI or token, and an optional purpose.
revoked?	action	token String jti String	Returns true if a revocation token is found for the provided token
revoke_token	create	token String extra_data Map attribute	Revoke a token. Creates a revocation token corresponding to the provided token.
revoke_jti	create	subject String jti String extra_data Map attribute	Revoke a token by JTI. Creates a revocation token corresponding to the provided jti.
store_token	create	token String extra_data Map attribute purpose String attribute	Stores a token used for the provided purpose.
expunge_expired	destroy		Deletes expired tokens.
revoke_all_stored_for_subject	update	subject String extra_data Map attribute	Revokes all stored tokens for a specific subject.

Team

Attributes

Name	Type	Description
id	UUIDv7
name	String
domain	String
description	String
inserted_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
owner_user_id	UUID

Actions

Name	Type	Input	Description
destroy	destroy
read	read
create	create	name String attribute domain String attribute description String attribute
list_user_teams	read		List all teams that a user is a member of
update_team	update	name String attribute domain String attribute description String attribute

UserTeam

Attributes

Name	Type	Description
id	UUIDv7
role	String
inserted_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
user_id	UUID
team_id	UUID

Actions

Name	Type	Input
destroy	destroy
update	update	user_id UUID attribute team_id UUID attribute
read	read
create	create	user_id UUID attribute team_id UUID attribute
list_team_members	read
add_team_member	create	user_id UUID attribute role String attribute
change_member_role	update	role String attribute
remove_team_member	destroy
leave_team	destroy
is_member?	action	user_id String

Invitation

Attributes

Name	Type	Description
id	UUIDv7
invited_user_id	UUID
inviter_user_id	UUID
team_id	UUID

Actions

Name	Type	Input
read	read
list_received_invitations	read
list_invitations_sent	read
invite_user	create	invited_user_id UUID attribute
cancel_invitation	destroy
decline_invitation	destroy
accept_invitation	destroy

Group

Attributes

Name	Type	Description
id	UUIDv7
name	String	Group name unique name
description	String	Describes the intention of the group
inserted_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec

Actions

Name	Type	Input
destroy	destroy
update	update	name String attribute description String attribute
read	read
create	create	name String attribute description String attribute

GroupPermission

Attributes

Name	Type	Description
id	UUIDv7
action	String
resource	String
inserted_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
group_id	UUID

Actions

Name	Type	Input
destroy	destroy
update	update	resource String attribute action String attribute group_id UUID attribute
read	read
create	create	resource String attribute action String attribute group_id UUID attribute

UserGroup

Attributes

Name	Type	Description
id	UUIDv7
inserted_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
group_id	UUID
user_id	UUID

Actions

Name	Type	Input
destroy	destroy
update	update	user_id UUID attribute group_id UUID attribute
read	read
create	create	user_id UUID attribute group_id UUID attribute

User

Attributes

Name	Type	Description
id	UUIDv7
name	String
email	CiString
current_team	String	The current team the user is accessing the app with
hashed_password	String
picture	String
confirmed_at	UtcDatetimeUsec

Actions

Name	Type	Input	Description
confirm	update	confirm String email CiString attribute
log_out_everywhere	action	user Struct The user to log out
update	update
read	read
destroy	destroy
current_user	read
set_current_team	update	team String	Set the current team for the user
get_by_subject	read	subject String	Get a user by the subject claim in a JWT
change_password	update	current_password String password String password_confirmation String
sign_in_with_password	read	email CiString The email to use for retrieving the user. password String The password to check for the matching user.	Attempt to sign in using a email and password.
sign_in_with_token	read	token String The short-lived sign in token.	Attempt to sign in using a short-lived sign in token.
register_with_password	create	name String email CiString password String The proposed password for the user, in plain text. password_confirmation String The proposed password for the user (again), in plain text.	Register a new user with a email and password.
request_password_reset_token	action	email CiString	Send password reset instructions to a user if they exist.
get_by_email	read	email CiString	Looks up a user by their email
reset_password_with_token	update	reset_token String password String The proposed password for the user, in plain text. password_confirmation String The proposed password for the user (again), in plain text.
search_users	read	search String
sign_in_with_api_key	read	api_key String

UserIdentity

Attributes

Name	Type	Description
refresh_token	String
access_token_expires_at	UtcDatetimeUsec
access_token	String
uid	String
strategy	String
id	UUID
user_id	UUIDv7

Actions

Name	Type	Input
read	read
destroy	destroy
upsert	create	user_info Map oauth_tokens Map user_id UUIDv7 strategy String attribute

Notification

Attributes

Name	Type	Description
id	UUID
sender_user_id	UUID	The user who sent the notification
recipient_user_id	UUID	The user who received the notification
subject	String	The subject of the notification
body	String	The body of the notification
read_at	DateTime	The time a notification has been read
status	Atom	The status of the notification
processed	Boolean	Whether the notification has been processed
inserted_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec

Actions

Name	Type	Input	Description
destroy	destroy
update	update	sender_user_id UUID attribute recipient_user_id UUID attribute subject String attribute body String attribute read_at DateTime attribute status Atom attribute
create	create	sender_user_id UUID attribute recipient_user_id UUID attribute subject String attribute body String attribute read_at DateTime attribute status Atom attribute
read	read
send	update	sender_user_id UUID attribute recipient_user_id UUID attribute subject String attribute body String attribute read_at DateTime attribute status Atom attribute	Send a new user notification to the user
unprocessed	read		Read unprocessed notifications
for_user	read

ApiKey

Attributes

Name	Type	Description
id	UUID
api_key_hash	Binary
expires_at	UtcDatetimeUsec
user_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
create	create	user_id UUID attribute expires_at UtcDatetimeUsec attribute

Domain Kyozo.Workspaces

Class Diagram

classDiagram
    class Workspace {
        UUIDv7 id
        String name
        String description
        Atom status
        Atom storage_backend
        Map settings
        String[] tags
        String storage_path
        Map storage_metadata
        String git_repository_url
        String git_branch
        UtcDatetimeUsec archived_at
        UtcDatetimeUsec deleted_at
        destroy()
        update(String name, String description, Atom storage_backend, Map settings)
        read()
        create(String name, String description, Atom storage_backend, Map settings)
        list_workspaces()
        list_active_workspaces()
        list_archived_workspaces()
        search_workspaces(String query)
        create_workspace(Boolean initialize_git, Boolean create_readme, String name, String description, ...)
        update_workspace(String name, String description, String[] tags, Map settings)
        archive_workspace()
        restore_workspace()
        change_storage_backend(Atom new_backend, Boolean migrate_files, String name, String description, ...)
        get_storage_info()
        get_statistics()
        cleanup_storage(Boolean dry_run)
        duplicate_workspace(String new_name, UUID copy_to_team_id, Boolean include_files, Boolean include_nfiles)
        soft_delete()
        hard_delete()
    }
    class Role {
        String name
    }
    class File {
        String description_html
        String content_html
        UUIDv7 id
        String name
        String file_path
        String content_type
        String description
        String[] tags
        Integer file_size
        Atom storage_backend
        Map storage_metadata
        String version
        String checksum
        Boolean is_directory
        Boolean is_binary
        Boolean is_notebook_file
        Map render_cache
        Integer view_count
        UtcDatetimeUsec last_viewed_at
        UtcDatetimeUsec deleted_at
        UUID workspace_id
        UUID parent_file_id
        Map markdown_stats
        Notebook[] notebooks
        Notebook primary_notebook
        destroy()
        read()
        list_files()
        list_by_type(String content_type)
        search(String query)
        create_file(String content, String initial_commit_message, String name, String content_type, ...)
        create_folder(String initial_commit_message, String name, String content_type, String description, ...)
        upload_file(Map file_upload, String initial_commit_message, String name, String content_type, ...)
        update_content(String content, String commit_message, String name, String content_type, ...)
        rename_file(String new_name, String commit_message, String name, String content_type, ...)
        move_file(UUID new_parent_id, String commit_message, String name, String content_type, ...)
        update_metadata(String description, String[] tags, String content_type)
        update(String name, String content_type, String description, String[] tags)
        view_file()
        get_content(String version)
        list_versions()
        render_as(Atom target_format, Map options)
        resolve_to_media(Boolean force_create)
        resolve_to_notebook(Boolean force_create)
        get_specialized_content()
        create_version(String content, String commit_message)
        duplicate_file(String new_name, UUID copy_to_workspace_id, String initial_commit_message)
        list_folder_contents(UUID folder_id)
        soft_delete()
        hard_delete()
    }
    class FileStorage {
        UUIDv7 id
        UUID storage_resource_id
        Atom relationship_type
        Atom media_type
        Boolean is_primary
        Integer priority
        Map metadata
        Atom processing_status
        String processing_error
        UtcDatetimeUsec expires_at
        UUID team_id
        UUID user_id
        UUID file_id
        StorageResource storage_resource
        File file
        destroy()
        read()
        list_by_media_type()
        by_relationship_type(Atom relationship_type)
        primary_storage()
        create_from_content(String content, String filename, String mime_type, Atom storage_backend, ...)
        create_from_upload(Map upload, Atom storage_backend, Map processing_options, Atom relationship_type, ...)
        create_from_locator(Map locator, Atom relationship_type, Map metadata, Integer priority, ...)
        update_metadata(Map metadata, Integer priority, Atom processing_status, String processing_error)
        set_as_primary()
        get_content()
        duplicate_to_backend(Atom target_backend, Atom relationship_type)
        process_content(Map processing_options)
        cleanup_expired()
        create(UUID storage_resource_id, UUID file_id, Atom relationship_type, Atom media_type, ...)
        update(Atom relationship_type, Map metadata, Integer priority, Atom processing_status, ...)
        by_file(UUID file_id)
        primary_for_file(UUID file_id)
        create_file_content(UUID file_id, String content, String filename, String mime_type, ...)
        create_file_version(UUID file_id, String content, String version_name, String commit_message, ...)
        update_file_storage(Atom relationship_type, Map metadata, Integer priority, Atom processing_status, ...)
        convert_format(String target_format, Map conversion_options)
        extract_text()
        search_content(String query, Map search_options)
        update_file_content(UUID file_id, String content, String commit_message)
    }
    class ImageStorage {
        UUIDv7 id
        UUID storage_resource_id
        Atom relationship_type
        Atom media_type
        Boolean is_primary
        Integer priority
        Map metadata
        Atom processing_status
        String processing_error
        UtcDatetimeUsec expires_at
        UUID team_id
        UUID user_id
        UUID file_id
        UUID original_image_id
        StorageResource storage_resource
        File file
        ImageStorage original_image
        destroy()
        read()
        list_by_media_type()
        by_relationship_type(Atom relationship_type)
        primary_storage()
        create_from_content(String content, String filename, String mime_type, Atom storage_backend, ...)
        create_from_upload(Map upload, Atom storage_backend, Map processing_options, Atom relationship_type, ...)
        create_from_locator(Map locator, Atom relationship_type, Map metadata, Integer priority, ...)
        update_metadata(Map metadata, Integer priority, Atom processing_status, String processing_error)
        set_as_primary()
        get_content()
        duplicate_to_backend(Atom target_backend, Atom relationship_type)
        process_content(Map processing_options)
        cleanup_expired()
        create(UUID storage_resource_id, UUID file_id, Atom relationship_type, Atom media_type, ...)
        update(Atom relationship_type, Map metadata, Integer priority, Atom processing_status, ...)
        create_with_thumbnails(UUID file_id, String content, String filename, String mime_type, ...)
        generate_thumbnails(String[] sizes)
        convert_format(String target_format, Integer quality, Boolean progressive)
        extract_colors()
        detect_faces()
        optimize_for_web(Integer max_width, Integer max_height, Integer quality)
    }
    class FileMedia {
        UUIDv7 id
        UUID storage_resource_id
        Atom relationship_type
        Atom media_type
        Boolean is_primary
        Integer priority
        Map metadata
        Atom processing_status
        String processing_error
        UtcDatetimeUsec expires_at
        UUID team_id
        UUID user_id
        UUID file_id
        StorageResource storage_resource
        File file
        destroy()
        read()
        list_by_media_type()
        by_relationship_type(Atom relationship_type)
        primary_storage()
        create_from_content(String content, String filename, String mime_type, Atom storage_backend, ...)
        create_from_upload(Map upload, Atom storage_backend, Map processing_options, Atom relationship_type, ...)
        create_from_locator(Map locator, Atom relationship_type, Map metadata, Integer priority, ...)
        update_metadata(Map metadata, Integer priority, Atom processing_status, String processing_error)
        set_as_primary()
        get_content()
        duplicate_to_backend(Atom target_backend, Atom relationship_type)
        process_content(Map processing_options)
        cleanup_expired()
        create(UUID storage_resource_id, UUID file_id, Atom relationship_type, Atom media_type, ...)
        update(Atom relationship_type, Map metadata, Integer priority, Atom processing_status, ...)
        by_file(UUID file_id)
        primary_for_file(UUID file_id)
        create_from_file(UUID file_id, String content, Atom storage_backend, Atom relationship_type, ...)
        create_thumbnail(UUID file_id, Integer width, Integer height, String format, ...)
        generate_thumbnails(Map[] sizes)
        extract_colors(Integer max_colors)
        convert_format(String target_format, Integer quality, Boolean progressive)
        optimize_image(Integer target_size, Integer quality)
    }
    class FileNotebook {
        UUIDv7 id
        UUID storage_resource_id
        Atom relationship_type
        Atom media_type
        Boolean is_primary
        Integer priority
        Map metadata
        Atom processing_status
        String processing_error
        UtcDatetimeUsec expires_at
        UUID team_id
        UUID user_id
        UUID file_id
        UUID notebook_id
        StorageResource storage_resource
        File file
        Notebook notebook
        destroy()
        read()
        list_by_media_type()
        by_relationship_type(Atom relationship_type)
        primary_storage()
        create_from_content(String content, String filename, String mime_type, Atom storage_backend, ...)
        create_from_upload(Map upload, Atom storage_backend, Map processing_options, Atom relationship_type, ...)
        create_from_locator(Map locator, Atom relationship_type, Map metadata, Integer priority, ...)
        update_metadata(Map metadata, Integer priority, Atom processing_status, String processing_error)
        set_as_primary()
        get_content()
        duplicate_to_backend(Atom target_backend, Atom relationship_type)
        process_content(Map processing_options)
        cleanup_expired()
        create(UUID storage_resource_id, UUID file_id, UUID notebook_id, Atom relationship_type, ...)
        update(Atom relationship_type, Map metadata, Integer priority, Atom processing_status, ...)
        by_file(UUID file_id)
        primary_for_file(UUID file_id)
        create_from_file(UUID file_id, String content, Atom storage_backend, String notebook_format, ...)
        create_checkpoint(UUID file_id, String checkpoint_name, Boolean include_outputs, Atom relationship_type, ...)
        execute_cells(String[] cell_ids, String kernel_name, Integer execution_timeout)
        clear_outputs()
        convert_format(String target_format, Boolean include_outputs, String template)
        extract_code(String language, Boolean include_markdown)
        analyze_dependencies()
        validate_notebook()
    }
    class Notebook {
        UUIDv7 id
        String title
        String file_path
        String content
        String content_html
        Atom status
        Map execution_state
        Map[] cells
        Map[] extracted_tasks
        String[] execution_order
        Integer current_task_index
        Integer total_execution_time
        UtcDatetimeUsec last_executed_at
        Integer execution_count
        Boolean auto_save_enabled
        Boolean collaborative_mode
        Atom kernel_status
        Map environment_variables
        Integer execution_timeout
        Map render_cache
        Map metadata
        UtcDatetimeUsec last_accessed_at
        UUID file_id
        UUID workspace_id
        UUID team_id
        Map markdown_stats
        File file
        Workspace workspace
        Team team
        destroy()
        read()
        list_notebooks()
        list_by_workspace(UUID workspace_id)
        list_by_status(Atom status)
        list_executable()
        create_from_document(UUID file_id)
        update_content(String content, String title, Map metadata)
        execute_notebook(Map environment_variables, Integer timeout_seconds)
        execute_task(String task_id, Map environment_variables)
        stop_execution()
        reset_execution()
        update_execution_state(Map execution_state, Integer current_task_index, Atom kernel_status)
        toggle_collaborative_mode()
        update_access_time()
        duplicate_notebook(String new_title, UUID copy_to_workspace_id)
    }
    class Blob {
        UUIDv7 id
        String hash
        Integer size
        String content_type
        String encoding
        destroy()
        read()
        create_blob(String content, String content_type, String encoding)
        find_or_create(String content, String content_type, String encoding)
        get_content()
        exists?(String hash)
    }
    class Task {
        UUIDv7 id
        UUID workspace_id
        String name
        Boolean is_name_generated
        String language
        String code
        String description
        Integer line_start
        Integer line_end
        Integer order_index
        Integer execution_count
        Atom last_execution_status
        String last_execution_output
        String last_execution_error
        Integer execution_time_ms
        Boolean is_executable
        Boolean requires_input
        String[] dependencies
        Map environment_variables
        String working_directory
        Integer timeout_seconds
        Map metadata
        UtcDatetimeUsec last_executed_at
        UUID notebook_id
        Workspace workspace
        Notebook notebook
        destroy()
        read()
        list_tasks()
        list_notebook_tasks(UUID notebook_id)
        list_workspace_tasks(UUID workspace_id)
        executable_tasks_only()
        create(UUID workspace_id, String name, Boolean is_name_generated, String language, ...)
        update_execution_result(Integer execution_count, Atom last_execution_status, String last_execution_output, String last_execution_error, ...)
        mark_successful_execution(String output, Integer execution_time_ms)
        mark_failed_execution(String error, Integer execution_time_ms)
    }
    class LoadEvent {
        UUIDv7 id
        Atom event_type
        Map event_data
        String path
        String error_message
        String task_name
        String task_workspace_id
        Boolean is_task_name_generated
        Integer processing_time_ms
        Integer sequence_number
        UUID workspace_id
        UUID notebook_id
        UUID task_id
        Workspace workspace
        Notebook notebook
        Task task
        destroy()
        read()
        list_events()
        list_workspace_events(UUID workspace_id)
        list_error_events()
        list_events_by_type(Atom event_type)
        log_started_walk(Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_found_dir(String path, Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_found_file(String path, Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_finished_walk(Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_started_parsing_doc(String path, Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_finished_parsing_doc(String path, Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_found_task(String path, String task_name, String task_workspace_id, Boolean is_task_name_generated, ...)
        log_error(String path, String error_message, Integer sequence_number, Integer processing_time_ms, ...)
        create_generic(Atom event_type, Map event_data, String path, String error_message, ...)
    }

    Team -- File
    Team -- FileMedia
    Team -- FileNotebook
    Team -- FileStorage
    Team -- ImageStorage
    Team -- Notebook
    Team -- Workspace
    User -- FileMedia
    User -- FileNotebook
    User -- FileStorage
    User -- ImageStorage
    User -- Workspace
    UserTeam -- File
    UserTeam -- Role
    StorageResource -- File
    StorageResource -- FileMedia
    StorageResource -- FileNotebook
    StorageResource -- FileStorage
    StorageResource -- ImageStorage
    File -- File
    File -- FileMedia
    File -- FileNotebook
    File -- FileStorage
    File -- ImageStorage
    File -- Notebook
    File -- Workspace
    FileNotebook -- Notebook
    ImageStorage -- ImageStorage
    LoadEvent -- Notebook
    LoadEvent -- Task
    LoadEvent -- Workspace
    Notebook -- Task
    Notebook -- Workspace
    Task -- Workspace

ER Diagram

erDiagram
    "Workspace" {
        UUIDv7 id
        String name
        String description
        Atom status
        Atom storage_backend
        Map settings
        ArrayOfString tags
        String storage_path
        Map storage_metadata
        String git_repository_url
        String git_branch
        UtcDatetimeUsec archived_at
        UtcDatetimeUsec deleted_at
    }
    "Role" {
        String name
    }
    "File" {
        String description_html
        String content_html
        UUIDv7 id
        String name
        String file_path
        String content_type
        String description
        ArrayOfString tags
        Integer file_size
        Atom storage_backend
        Map storage_metadata
        String version
        String checksum
        Boolean is_directory
        Boolean is_binary
        Boolean is_notebook_file
        Map render_cache
        Integer view_count
        UtcDatetimeUsec last_viewed_at
        UtcDatetimeUsec deleted_at
        UUID workspace_id
        UUID parent_file_id
        Map markdown_stats
    }
    "FileStorage" {
        UUIDv7 id
        UUID storage_resource_id
        Atom relationship_type
        Atom media_type
        Boolean is_primary
        Integer priority
        Map metadata
        Atom processing_status
        String processing_error
        UtcDatetimeUsec expires_at
        UUID team_id
        UUID user_id
        UUID file_id
    }
    "ImageStorage" {
        UUIDv7 id
        UUID storage_resource_id
        Atom relationship_type
        Atom media_type
        Boolean is_primary
        Integer priority
        Map metadata
        Atom processing_status
        String processing_error
        UtcDatetimeUsec expires_at
        UUID team_id
        UUID user_id
        UUID file_id
        UUID original_image_id
    }
    "FileMedia" {
        UUIDv7 id
        UUID storage_resource_id
        Atom relationship_type
        Atom media_type
        Boolean is_primary
        Integer priority
        Map metadata
        Atom processing_status
        String processing_error
        UtcDatetimeUsec expires_at
        UUID team_id
        UUID user_id
        UUID file_id
    }
    "FileNotebook" {
        UUIDv7 id
        UUID storage_resource_id
        Atom relationship_type
        Atom media_type
        Boolean is_primary
        Integer priority
        Map metadata
        Atom processing_status
        String processing_error
        UtcDatetimeUsec expires_at
        UUID team_id
        UUID user_id
        UUID file_id
        UUID notebook_id
    }
    "Notebook" {
        UUIDv7 id
        String title
        String file_path
        String content
        String content_html
        Atom status
        Map execution_state
        ArrayOfMap cells
        ArrayOfMap extracted_tasks
        ArrayOfString execution_order
        Integer current_task_index
        Integer total_execution_time
        UtcDatetimeUsec last_executed_at
        Integer execution_count
        Boolean auto_save_enabled
        Boolean collaborative_mode
        Atom kernel_status
        Map environment_variables
        Integer execution_timeout
        Map render_cache
        Map metadata
        UtcDatetimeUsec last_accessed_at
        UUID file_id
        UUID workspace_id
        UUID team_id
        Map markdown_stats
    }
    "Blob" {
        UUIDv7 id
        String hash
        Integer size
        String content_type
        String encoding
    }
    "Task" {
        UUIDv7 id
        UUID workspace_id
        String name
        Boolean is_name_generated
        String language
        String code
        String description
        Integer line_start
        Integer line_end
        Integer order_index
        Integer execution_count
        Atom last_execution_status
        String last_execution_output
        String last_execution_error
        Integer execution_time_ms
        Boolean is_executable
        Boolean requires_input
        ArrayOfString dependencies
        Map environment_variables
        String working_directory
        Integer timeout_seconds
        Map metadata
        UtcDatetimeUsec last_executed_at
        UUID notebook_id
    }
    "LoadEvent" {
        UUIDv7 id
        Atom event_type
        Map event_data
        String path
        String error_message
        String task_name
        String task_workspace_id
        Boolean is_task_name_generated
        Integer processing_time_ms
        Integer sequence_number
        UUID workspace_id
        UUID notebook_id
        UUID task_id
    }

    "Team" ||--|| "File" : ""
    "Team" ||--|| "FileMedia" : ""
    "Team" ||--|| "FileNotebook" : ""
    "Team" ||--|| "FileStorage" : ""
    "Team" ||--|| "ImageStorage" : ""
    "Team" ||--|| "Notebook" : ""
    "Team" ||--|| "Workspace" : ""
    "User" ||--|| "FileMedia" : ""
    "User" ||--|| "FileNotebook" : ""
    "User" ||--|| "FileStorage" : ""
    "User" ||--|| "ImageStorage" : ""
    "User" ||--|| "Workspace" : ""
    "UserTeam" ||--|| "File" : ""
    "UserTeam" ||--|| "Role" : ""
    "StorageResource" ||--|| "File" : ""
    "StorageResource" ||--|| "FileMedia" : ""
    "StorageResource" ||--|| "FileNotebook" : ""
    "StorageResource" ||--|| "FileStorage" : ""
    "StorageResource" ||--|| "ImageStorage" : ""
    "File" ||--|| "File" : ""
    "File" ||--|| "FileMedia" : ""
    "File" ||--|| "FileNotebook" : ""
    "File" ||--|| "FileStorage" : ""
    "File" ||--|| "ImageStorage" : ""
    "File" ||--|| "Notebook" : ""
    "File" ||--|| "Workspace" : ""
    "FileNotebook" ||--|| "Notebook" : ""
    "ImageStorage" ||--|| "ImageStorage" : ""
    "LoadEvent" ||--|| "Notebook" : ""
    "LoadEvent" ||--|| "Task" : ""
    "LoadEvent" ||--|| "Workspace" : ""
    "Notebook" ||--|| "Task" : ""
    "Notebook" ||--|| "Workspace" : ""
    "Task" ||--|| "Workspace" : ""

Workspace

Attributes

Name	Type	Description
id	UUIDv7
name	String
description	String
status	Atom
storage_backend	Atom
settings	Map
tags	String[]
storage_path	String
storage_metadata	Map
git_repository_url	String
git_branch	String
archived_at	UtcDatetimeUsec
deleted_at	UtcDatetimeUsec
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
team_id	UUID
created_by_id	UUID

Actions

Name	Type	Input
destroy	destroy
update	update	name String attribute description String attribute storage_backend Atom attribute settings Map attribute
read	read
create	create	name String attribute description String attribute storage_backend Atom attribute settings Map attribute
list_workspaces	read
list_active_workspaces	read
list_archived_workspaces	read
search_workspaces	read	query String
create_workspace	create	initialize_git Boolean create_readme Boolean name String attribute description String attribute storage_backend Atom attribute settings Map attribute
update_workspace	update	name String attribute description String attribute tags String[] attribute settings Map attribute
archive_workspace	update
restore_workspace	update
change_storage_backend	update	new_backend Atom migrate_files Boolean name String attribute description String attribute storage_backend Atom attribute settings Map attribute
get_storage_info	action
get_statistics	action
cleanup_storage	action	dry_run Boolean
duplicate_workspace	action	new_name String copy_to_team_id UUID include_files Boolean include_nfiles Boolean
soft_delete	destroy
hard_delete	destroy

Role

Attributes

Name	Type	Description
name	String

Actions

Name	Type	Input	Description

File

Attributes

Name	Type	Description
description_html	String	HTML rendered from markdown content
content_html	String	HTML rendered from markdown content
id	UUIDv7
name	String
file_path	String
content_type	String
description	String
tags	String[]
file_size	Integer
storage_backend	Atom
storage_metadata	Map
version	String
checksum	String
is_directory	Boolean
is_binary	Boolean
is_notebook_file	Boolean
render_cache	Map
view_count	Integer
last_viewed_at	UtcDatetimeUsec
deleted_at	UtcDatetimeUsec
workspace_id	UUID
parent_file_id	UUID
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
team_member_id	UUID
team_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_files	read
list_by_type	read	content_type String
search	read	query String
create_file	create	content String initial_commit_message String name String attribute content_type String attribute description String attribute tags String[] attribute is_directory Boolean attribute parent_file_id UUID attribute
create_folder	create	initial_commit_message String name String attribute content_type String attribute description String attribute tags String[] attribute is_directory Boolean attribute parent_file_id UUID attribute
upload_file	create	file_upload Map initial_commit_message String name String attribute content_type String attribute description String attribute tags String[] attribute is_directory Boolean attribute parent_file_id UUID attribute
update_content	update	content String commit_message String name String attribute content_type String attribute description String attribute tags String[] attribute is_directory Boolean attribute parent_file_id UUID attribute
rename_file	update	new_name String commit_message String name String attribute content_type String attribute description String attribute tags String[] attribute is_directory Boolean attribute parent_file_id UUID attribute
move_file	update	new_parent_id UUID commit_message String name String attribute content_type String attribute description String attribute tags String[] attribute is_directory Boolean attribute parent_file_id UUID attribute
update_metadata	update	description String attribute tags String[] attribute content_type String attribute
update	update	name String attribute content_type String attribute description String attribute tags String[] attribute
view_file	action
get_content	action	version String
list_versions	action
render_as	action	target_format Atom options Map
resolve_to_media	action	force_create Boolean
resolve_to_notebook	action	force_create Boolean
get_specialized_content	action
create_version	action	content String commit_message String
duplicate_file	action	new_name String copy_to_workspace_id UUID initial_commit_message String
list_folder_contents	action	folder_id UUID
soft_delete	destroy
hard_delete	destroy

FileStorage

Attributes

Name	Type	Description
id	UUIDv7
storage_resource_id	UUID	Reference to the underlying StorageResource
relationship_type	Atom	Type of relationship to the parent resource
media_type	Atom	Media type category
is_primary	Boolean	Whether this is the primary storage for the resource
priority	Integer	Priority for storage selection (lower = higher priority)
metadata	Map	Media-specific metadata and processing information
processing_status	Atom	Status of any background processing
processing_error	String	Error message if processing failed
expires_at	UtcDatetimeUsec	When this storage entry expires (for temporary/cache entries)
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
team_id	UUID
user_id	UUID
file_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_by_media_type	read
by_relationship_type	read	relationship_type Atom
primary_storage	read
create_from_content	create	content String filename String mime_type String storage_backend Atom processing_options Map relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_from_upload	create	upload Map storage_backend Atom processing_options Map relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_from_locator	create	locator Map relationship_type Atom metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
update_metadata	update	metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute
set_as_primary	update
get_content	action
duplicate_to_backend	action	target_backend Atom relationship_type Atom
process_content	action	processing_options Map
cleanup_expired	action
create	create	storage_resource_id UUID attribute file_id UUID attribute relationship_type Atom attribute media_type Atom attribute is_primary Boolean attribute metadata Map attribute
update	update	relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
by_file	read	file_id UUID
primary_for_file	read	file_id UUID
create_file_content	create	file_id UUID content String filename String mime_type String storage_backend Atom relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_file_version	create	file_id UUID content String version_name String commit_message String relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
update_file_storage	update	relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
convert_format	action	target_format String conversion_options Map
extract_text	action
search_content	action	query String search_options Map
update_file_content	action	file_id UUID content String commit_message String

ImageStorage

Attributes

Name	Type	Description
id	UUIDv7
storage_resource_id	UUID	Reference to the underlying StorageResource
relationship_type	Atom	Type of relationship to the parent resource
media_type	Atom	Media type category
is_primary	Boolean	Whether this is the primary storage for the resource
priority	Integer	Priority for storage selection (lower = higher priority)
metadata	Map	Media-specific metadata and processing information
processing_status	Atom	Status of any background processing
processing_error	String	Error message if processing failed
expires_at	UtcDatetimeUsec	When this storage entry expires (for temporary/cache entries)
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
team_id	UUID
user_id	UUID
file_id	UUID
original_image_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_by_media_type	read
by_relationship_type	read	relationship_type Atom
primary_storage	read
create_from_content	create	content String filename String mime_type String storage_backend Atom processing_options Map relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_from_upload	create	upload Map storage_backend Atom processing_options Map relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_from_locator	create	locator Map relationship_type Atom metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
update_metadata	update	metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute
set_as_primary	update
get_content	action
duplicate_to_backend	action	target_backend Atom relationship_type Atom
process_content	action	processing_options Map
cleanup_expired	action
create	create	storage_resource_id UUID attribute file_id UUID attribute relationship_type Atom attribute media_type Atom attribute is_primary Boolean attribute metadata Map attribute
update	update	relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_with_thumbnails	create	file_id UUID content String filename String mime_type String thumbnail_sizes String[] relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
generate_thumbnails	action	sizes String[]
convert_format	action	target_format String quality Integer progressive Boolean
extract_colors	action
detect_faces	action
optimize_for_web	action	max_width Integer max_height Integer quality Integer

FileMedia

Attributes

Name	Type	Description
id	UUIDv7
storage_resource_id	UUID	Reference to the underlying StorageResource
relationship_type	Atom	Type of relationship to the parent resource
media_type	Atom	Media type category
is_primary	Boolean	Whether this is the primary storage for the resource
priority	Integer	Priority for storage selection (lower = higher priority)
metadata	Map	Media-specific metadata and processing information
processing_status	Atom	Status of any background processing
processing_error	String	Error message if processing failed
expires_at	UtcDatetimeUsec	When this storage entry expires (for temporary/cache entries)
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
team_id	UUID
user_id	UUID
file_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_by_media_type	read
by_relationship_type	read	relationship_type Atom
primary_storage	read
create_from_content	create	content String filename String mime_type String storage_backend Atom processing_options Map relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_from_upload	create	upload Map storage_backend Atom processing_options Map relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_from_locator	create	locator Map relationship_type Atom metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
update_metadata	update	metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute
set_as_primary	update
get_content	action
duplicate_to_backend	action	target_backend Atom relationship_type Atom
process_content	action	processing_options Map
cleanup_expired	action
create	create	storage_resource_id UUID attribute file_id UUID attribute relationship_type Atom attribute media_type Atom attribute is_primary Boolean attribute metadata Map attribute
update	update	relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
by_file	read	file_id UUID
primary_for_file	read	file_id UUID
create_from_file	create	file_id UUID content String storage_backend Atom relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_thumbnail	create	file_id UUID width Integer height Integer format String relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
generate_thumbnails	action	sizes Map[]
extract_colors	action	max_colors Integer
convert_format	action	target_format String quality Integer progressive Boolean
optimize_image	action	target_size Integer quality Integer

FileNotebook

Attributes

Name	Type	Description
id	UUIDv7
storage_resource_id	UUID	Reference to the underlying StorageResource
relationship_type	Atom	Type of relationship to the parent resource
media_type	Atom	Media type category
is_primary	Boolean	Whether this is the primary storage for the resource
priority	Integer	Priority for storage selection (lower = higher priority)
metadata	Map	Media-specific metadata and processing information
processing_status	Atom	Status of any background processing
processing_error	String	Error message if processing failed
expires_at	UtcDatetimeUsec	When this storage entry expires (for temporary/cache entries)
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
team_id	UUID
user_id	UUID
file_id	UUID
notebook_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_by_media_type	read
by_relationship_type	read	relationship_type Atom
primary_storage	read
create_from_content	create	content String filename String mime_type String storage_backend Atom processing_options Map relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_from_upload	create	upload Map storage_backend Atom processing_options Map relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_from_locator	create	locator Map relationship_type Atom metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
update_metadata	update	metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute
set_as_primary	update
get_content	action
duplicate_to_backend	action	target_backend Atom relationship_type Atom
process_content	action	processing_options Map
cleanup_expired	action
create	create	storage_resource_id UUID attribute file_id UUID attribute notebook_id UUID attribute relationship_type Atom attribute media_type Atom attribute is_primary Boolean attribute metadata Map attribute
update	update	relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
by_file	read	file_id UUID
primary_for_file	read	file_id UUID
create_from_file	create	file_id UUID content String storage_backend Atom notebook_format String relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
create_checkpoint	create	file_id UUID checkpoint_name String include_outputs Boolean relationship_type Atom attribute metadata Map attribute priority Integer attribute processing_status Atom attribute processing_error String attribute expires_at UtcDatetimeUsec attribute
execute_cells	action	cell_ids String[] kernel_name String execution_timeout Integer
clear_outputs	action
convert_format	action	target_format String include_outputs Boolean template String
extract_code	action	language String include_markdown Boolean
analyze_dependencies	action
validate_notebook	action

Notebook

Attributes

Name	Type	Description
id	UUIDv7
title	String	Title of the notebook (derived from document)
file_path	String
content	String	Original markdown content from the document
content_html	String	Rendered HTML content with syntax highlighting
status	Atom	Current status of the notebook
execution_state	Map	Current execution state including task statuses and outputs
cells	Map[]	Tasks extracted from markdown code blocks
extracted_tasks	Map[]	Tasks extracted from markdown code blocks
execution_order	String[]	Order in which tasks should be executed
current_task_index	Integer	Index of currently executing or next task to execute
total_execution_time	Integer	Total execution time across all tasks in milliseconds
last_executed_at	UtcDatetimeUsec	When the notebook was last executed
execution_count	Integer	Number of times this notebook has been executed
auto_save_enabled	Boolean	Whether to automatically save execution results
collaborative_mode	Boolean	Whether collaborative editing is enabled
kernel_status	Atom	Status of the execution kernel
environment_variables	Map	Environment variables for task execution
execution_timeout	Integer	Default timeout for task execution in seconds
render_cache	Map	Cache of rendered content for performance
metadata	Map	Additional metadata for the notebook
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
last_accessed_at	UtcDatetimeUsec	When the notebook was last accessed
file_id	UUID
workspace_id	UUID
team_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_notebooks	read
list_by_workspace	read	workspace_id UUID
list_by_status	read	status Atom
list_executable	read
create_from_document	create	file_id UUID
update_content	update	content String attribute title String attribute metadata Map attribute
execute_notebook	update	environment_variables Map timeout_seconds Integer
execute_task	update	task_id String environment_variables Map
stop_execution	update
reset_execution	update
update_execution_state	update	execution_state Map attribute current_task_index Integer attribute kernel_status Atom attribute
toggle_collaborative_mode	update
update_access_time	update
duplicate_notebook	action	new_title String copy_to_workspace_id UUID

Blob

Attributes

Name	Type	Description
id	UUIDv7
hash	String	SHA-256 hash of the content
size	Integer	Size of the content in bytes
content_type	String	MIME type of the content
encoding	String	Text encoding (for text content)
created_at	UtcDatetimeUsec

Actions

Name	Type	Input
destroy	destroy
read	read
create_blob	create	content String content_type String attribute encoding String attribute
find_or_create	create	content String content_type String attribute encoding String attribute
get_content	action
exists?	action	hash String

Task

Attributes

Name	Type	Description
id	UUIDv7
workspace_id	UUID	Unique identifier from workspace parsing
name	String	Name of the task/code block
is_name_generated	Boolean	Whether the task name was auto-generated
language	String	Programming language of the code block (e.g., python, javascript, shell)
code	String	The executable code content
description	String	Optional description or documentation for the task
line_start	Integer	Starting line number in the notebook
line_end	Integer	Ending line number in the notebook
order_index	Integer	Order of this task within the notebook
execution_count	Integer	Number of times this task has been executed
last_execution_status	Atom	Status of the last execution
last_execution_output	String	Output from the last execution
last_execution_error	String	Error message from the last execution
execution_time_ms	Integer	Duration of last execution in milliseconds
is_executable	Boolean	Whether this task can be executed
requires_input	Boolean	Whether this task requires user input
dependencies	String[]	List of task IDs or names that this task depends on
environment_variables	Map	Environment variables required for execution
working_directory	String	Working directory for task execution
timeout_seconds	Integer	Execution timeout in seconds
metadata	Map	Additional metadata for the task
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
last_executed_at	UtcDatetimeUsec	When this task was last executed
notebook_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_tasks	read
list_notebook_tasks	read	notebook_id UUID
list_workspace_tasks	read	workspace_id UUID
executable_tasks_only	read
create	create	workspace_id UUID attribute name String attribute is_name_generated Boolean attribute language String attribute code String attribute description String attribute line_start Integer attribute line_end Integer attribute order_index Integer attribute is_executable Boolean attribute requires_input Boolean attribute dependencies String[] attribute environment_variables Map attribute working_directory String attribute timeout_seconds Integer attribute metadata Map attribute
update_execution_result	update	execution_count Integer attribute last_execution_status Atom attribute last_execution_output String attribute last_execution_error String attribute execution_time_ms Integer attribute last_executed_at UtcDatetimeUsec attribute
mark_successful_execution	update	output String execution_time_ms Integer
mark_failed_execution	update	error String execution_time_ms Integer

LoadEvent

Attributes

Name	Type	Description
id	UUIDv7
event_type	Atom	Type of the loading event
event_data	Map	Event-specific data payload
path	String	File or directory path related to this event
error_message	String	Error message if event_type is :error
task_name	String	Task name if event_type is :found_task
task_workspace_id	String	Task workspace ID if event_type is :found_task
is_task_name_generated	Boolean	Whether task name was generated if event_type is :found_task
processing_time_ms	Integer	Processing time for this event in milliseconds
sequence_number	Integer	Order of this event within the workspace loading sequence
occurred_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
workspace_id	UUID
notebook_id	UUID
task_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_events	read
list_workspace_events	read	workspace_id UUID
list_error_events	read
list_events_by_type	read	event_type Atom
log_started_walk	create	sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_found_dir	create	path String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_found_file	create	path String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_finished_walk	create	sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_started_parsing_doc	create	path String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_finished_parsing_doc	create	path String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_found_task	create	path String attribute task_name String attribute task_workspace_id String attribute is_task_name_generated Boolean attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_error	create	path String attribute error_message String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
create_generic	create	event_type Atom attribute event_data Map attribute path String attribute error_message String attribute task_name String attribute task_workspace_id String attribute is_task_name_generated Boolean attribute sequence_number Integer attribute processing_time_ms Integer attribute occurred_at UtcDatetimeUsec attribute

Domain Kyozo.Projects

Class Diagram

classDiagram
    class Project {
        UUIDv7 id
        String path
        Atom type
        String name
        Atom status
        Atom identity_mode
        Map options
        String error_message
        Integer document_count
        Integer task_count
        destroy()
        read()
        list_projects()
        load_directory(String path, Boolean skip_gitignore, String[] ignore_file_patterns, Boolean skip_repo_lookup_upward, ...)
        load_file(String path, Atom identity)
        load_project(String path, Map options, Atom identity)
        mark_loaded(Integer document_count, Integer task_count)
        mark_error(String error_message)
    }
    class Document {
        UUIDv7 id
        String path
        String absolute_path
        String filename
        String name
        String extension
        String content
        Map parsed_content
        Atom status
        String error_message
        Integer size_bytes
        Integer line_count
        Integer task_count
        Map metadata
        UtcDatetimeUsec parsed_at
        UtcDatetimeUsec modified_at
        UUID project_id
        Project project
        destroy()
        read()
        list_documents()
        list_project_documents(UUID project_id)
        create(String path, String absolute_path, String filename, String name, ...)
        update_content(String content, UtcDatetimeUsec modified_at)
        mark_parsed(Map parsed_content, Integer task_count, Map metadata)
        mark_error(String error_message)
    }
    class Task {
        UUIDv7 id
        String runme_id
        String name
        Boolean is_name_generated
        String language
        String code
        String description
        Integer line_start
        Integer line_end
        Integer order_index
        Integer execution_count
        Atom last_execution_status
        String last_execution_output
        String last_execution_error
        Integer execution_time_ms
        Boolean is_executable
        Boolean requires_input
        String[] dependencies
        Map environment_variables
        String working_directory
        Integer timeout_seconds
        Map metadata
        UtcDatetimeUsec last_executed_at
        UUID project_id
        UUID document_id
        Project project
        Document document
        destroy()
        read()
        list_tasks()
        list_document_tasks(UUID document_id)
        list_project_tasks(UUID project_id)
        executable_tasks_only()
        create(String runme_id, String name, Boolean is_name_generated, String language, ...)
        update_execution_result(Integer execution_count, Atom last_execution_status, String last_execution_output, String last_execution_error, ...)
        mark_successful_execution(String output, Integer execution_time_ms)
        mark_failed_execution(String error, Integer execution_time_ms)
    }
    class LoadEvent {
        UUIDv7 id
        Atom event_type
        Map event_data
        String path
        String error_message
        String task_name
        String task_runme_id
        Boolean is_task_name_generated
        Integer processing_time_ms
        Integer sequence_number
        UUID project_id
        UUID document_id
        UUID task_id
        Project project
        Document document
        Task task
        destroy()
        read()
        list_events()
        list_project_events(UUID project_id)
        list_error_events()
        list_events_by_type(Atom event_type)
        log_started_walk(Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_found_dir(String path, Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_found_file(String path, Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_finished_walk(Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_started_parsing_doc(String path, Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_finished_parsing_doc(String path, Integer sequence_number, Integer processing_time_ms, Map event_data)
        log_found_task(String path, String task_name, String task_runme_id, Boolean is_task_name_generated, ...)
        log_error(String path, String error_message, Integer sequence_number, Integer processing_time_ms, ...)
        create_generic(Atom event_type, Map event_data, String path, String error_message, ...)
    }

    User -- Project
    Document -- LoadEvent
    Document -- Project
    Document -- Task
    LoadEvent -- Project
    LoadEvent -- Task
    Project -- Task

ER Diagram

erDiagram
    "Project" {
        UUIDv7 id
        String path
        Atom type
        String name
        Atom status
        Atom identity_mode
        Map options
        String error_message
        Integer document_count
        Integer task_count
    }
    "Document" {
        UUIDv7 id
        String path
        String absolute_path
        String filename
        String name
        String extension
        String content
        Map parsed_content
        Atom status
        String error_message
        Integer size_bytes
        Integer line_count
        Integer task_count
        Map metadata
        UtcDatetimeUsec parsed_at
        UtcDatetimeUsec modified_at
        UUID project_id
    }
    "Task" {
        UUIDv7 id
        String runme_id
        String name
        Boolean is_name_generated
        String language
        String code
        String description
        Integer line_start
        Integer line_end
        Integer order_index
        Integer execution_count
        Atom last_execution_status
        String last_execution_output
        String last_execution_error
        Integer execution_time_ms
        Boolean is_executable
        Boolean requires_input
        ArrayOfString dependencies
        Map environment_variables
        String working_directory
        Integer timeout_seconds
        Map metadata
        UtcDatetimeUsec last_executed_at
        UUID project_id
        UUID document_id
    }
    "LoadEvent" {
        UUIDv7 id
        Atom event_type
        Map event_data
        String path
        String error_message
        String task_name
        String task_runme_id
        Boolean is_task_name_generated
        Integer processing_time_ms
        Integer sequence_number
        UUID project_id
        UUID document_id
        UUID task_id
    }

    "User" ||--|| "Project" : ""
    "Document" ||--|| "LoadEvent" : ""
    "Document" ||--|| "Project" : ""
    "Document" ||--|| "Task" : ""
    "LoadEvent" ||--|| "Project" : ""
    "LoadEvent" ||--|| "Task" : ""
    "Project" ||--|| "Task" : ""

Resources

Project
Document
Task
LoadEvent

Project

Attributes

Name	Type	Description
id	UUIDv7
path	String	The root path of the project
type	Atom	Whether this project was loaded from a directory or single file
name	String	The project name (derived from path)
status	Atom	Current loading status of the project
identity_mode	Atom	Controls if unique identifiers are inserted if not present
options	Map	Project-specific loading options
error_message	String	Error message if loading failed
document_count	Integer	Number of documents found in project
task_count	Integer	Number of tasks found in project
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
user_id	UUID

Actions

Name	Type	Input	Description
destroy	destroy
read	read
list_projects	read
load_directory	create	path String Path to directory containing the project skip_gitignore Boolean If true, .gitignore file is ignored ignore_file_patterns String[] List of file patterns to ignore (gitignore syntax) skip_repo_lookup_upward Boolean If true, disables looking up for .git folder in parent directories identity Atom Controls if unique identifiers are inserted	Load a project from a directory
load_file	create	path String Path to the file identity Atom Controls if unique identifiers are inserted	Load a project from a single file
load_project	create	path String Path to directory or file options Map Loading options (directory-specific options ignored for files) identity Atom Controls if unique identifiers are inserted	Load a project (auto-detects directory vs file)
mark_loaded	update	document_count Integer attribute task_count Integer attribute
mark_error	update	error_message String attribute

Document

Attributes

Name	Type	Description
id	UUIDv7
path	String	Path to the document relative to project root
absolute_path	String	Absolute filesystem path to the document
filename	String	Name of the file including extension
name	String	Document name without extension
extension	String	File extension
content	String	Raw markdown content of the document
parsed_content	Map	Parsed markdown structure (AST or similar)
status	Atom	Current parsing status of the document
error_message	String	Error message if parsing failed
size_bytes	Integer	File size in bytes
line_count	Integer	Number of lines in the document
task_count	Integer	Number of executable tasks found in this document
metadata	Map	Additional metadata extracted from document
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
parsed_at	UtcDatetimeUsec	When the document was last parsed
modified_at	UtcDatetimeUsec	File modification time
project_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_documents	read
list_project_documents	read	project_id UUID
create	create	path String attribute absolute_path String attribute filename String attribute name String attribute extension String attribute content String attribute size_bytes Integer attribute line_count Integer attribute modified_at UtcDatetimeUsec attribute metadata Map attribute
update_content	update	content String attribute modified_at UtcDatetimeUsec attribute
mark_parsed	update	parsed_content Map attribute task_count Integer attribute metadata Map attribute
mark_error	update	error_message String attribute

Task

Attributes

Name	Type	Description
id	UUIDv7
runme_id	String	Unique identifier from runme parsing
name	String	Name of the task/code block
is_name_generated	Boolean	Whether the task name was auto-generated
language	String	Programming language of the code block (e.g., python, javascript, shell)
code	String	The executable code content
description	String	Optional description or documentation for the task
line_start	Integer	Starting line number in the document
line_end	Integer	Ending line number in the document
order_index	Integer	Order of this task within the document
execution_count	Integer	Number of times this task has been executed
last_execution_status	Atom	Status of the last execution
last_execution_output	String	Output from the last execution
last_execution_error	String	Error message from the last execution
execution_time_ms	Integer	Duration of last execution in milliseconds
is_executable	Boolean	Whether this task can be executed
requires_input	Boolean	Whether this task requires user input
dependencies	String[]	List of task IDs or names that this task depends on
environment_variables	Map	Environment variables required for execution
working_directory	String	Working directory for task execution
timeout_seconds	Integer	Execution timeout in seconds
metadata	Map	Additional metadata for the task
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
last_executed_at	UtcDatetimeUsec	When this task was last executed
project_id	UUID
document_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_tasks	read
list_document_tasks	read	document_id UUID
list_project_tasks	read	project_id UUID
executable_tasks_only	read
create	create	runme_id String attribute name String attribute is_name_generated Boolean attribute language String attribute code String attribute description String attribute line_start Integer attribute line_end Integer attribute order_index Integer attribute is_executable Boolean attribute requires_input Boolean attribute dependencies String[] attribute environment_variables Map attribute working_directory String attribute timeout_seconds Integer attribute metadata Map attribute
update_execution_result	update	execution_count Integer attribute last_execution_status Atom attribute last_execution_output String attribute last_execution_error String attribute execution_time_ms Integer attribute last_executed_at UtcDatetimeUsec attribute
mark_successful_execution	update	output String execution_time_ms Integer
mark_failed_execution	update	error String execution_time_ms Integer

LoadEvent

Attributes

Name	Type	Description
id	UUIDv7
event_type	Atom	Type of the loading event
event_data	Map	Event-specific data payload
path	String	File or directory path related to this event
error_message	String	Error message if event_type is :error
task_name	String	Task name if event_type is :found_task
task_runme_id	String	Task runme ID if event_type is :found_task
is_task_name_generated	Boolean	Whether task name was generated if event_type is :found_task
processing_time_ms	Integer	Processing time for this event in milliseconds
sequence_number	Integer	Order of this event within the project loading sequence
occurred_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec
project_id	UUID
document_id	UUID
task_id	UUID

Actions

Name	Type	Input
destroy	destroy
read	read
list_events	read
list_project_events	read	project_id UUID
list_error_events	read
list_events_by_type	read	event_type Atom
log_started_walk	create	sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_found_dir	create	path String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_found_file	create	path String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_finished_walk	create	sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_started_parsing_doc	create	path String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_finished_parsing_doc	create	path String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_found_task	create	path String attribute task_name String attribute task_runme_id String attribute is_task_name_generated Boolean attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
log_error	create	path String attribute error_message String attribute sequence_number Integer attribute processing_time_ms Integer attribute event_data Map attribute
create_generic	create	event_type Atom attribute event_data Map attribute path String attribute error_message String attribute task_name String attribute task_runme_id String attribute is_task_name_generated Boolean attribute sequence_number Integer attribute processing_time_ms Integer attribute occurred_at UtcDatetimeUsec attribute

Domain Kyozo.Storage

Class Diagram

classDiagram
    class StorageResource {
        UUID id
        String locator_id
        String file_name
        String mime_type
        Integer file_size
        String checksum
        String version
        Atom storage_backend
        Map storage_metadata
        Boolean is_versioned
        UtcDatetimeUsec created_at
        UtcDatetimeUsec updated_at
        FileStorage[] file_storages
        ImageStorage[] image_storages
        destroy()
        update(String file_name, String mime_type, Integer file_size, String checksum, ...)
        read()
        list()
        create(String content, Struct upload, String locator_id, String file_name, ...)
        create_storage_entry(String content, Map storage_options, String file_name, String mime_type, ...)
        store_content(String content, String file_name, Atom storage_backend, Map storage_options)
        retrieve_content()
        delete_content()
        create_version(String content, String version_name, String commit_message)
        schedule_bulk_processing(Atom operation, Integer batch_size, Atom backend)
        schedule_maintenance(Atom maintenance_type, Integer max_age_hours, Integer batch_size)
    }

    StorageResource -- FileStorage
    StorageResource -- ImageStorage

ER Diagram

erDiagram
    "StorageResource" {
        UUID id
        String locator_id
        String file_name
        String mime_type
        Integer file_size
        String checksum
        String version
        Atom storage_backend
        Map storage_metadata
        Boolean is_versioned
        UtcDatetimeUsec created_at
        UtcDatetimeUsec updated_at
    }

    "StorageResource" ||--|| "FileStorage" : ""
    "StorageResource" ||--|| "ImageStorage" : ""

Resources

StorageResource

StorageResource

Attributes

Name	Type	Description
id	UUID
locator_id	String	Unique identifier for locating the stored content
file_name	String	Original filename
mime_type	String	MIME type of the stored content
file_size	Integer	Size of the file in bytes
checksum	String	SHA256 checksum of the content
version	String	Version identifier
storage_backend	Atom	Storage backend used for this resource
storage_metadata	Map	Backend-specific metadata
is_versioned	Boolean	Whether this resource supports versioning
created_at	UtcDatetimeUsec
updated_at	UtcDatetimeUsec

Actions

Name	Type	Input
destroy	destroy
update	update	file_name String attribute mime_type String attribute file_size Integer attribute checksum String attribute version String attribute storage_backend Atom attribute storage_metadata Map attribute is_versioned Boolean attribute
read	read
list	read
create	create	content String upload Struct locator_id String file_name String attribute mime_type String attribute file_size Integer attribute checksum String attribute version String attribute storage_backend Atom attribute storage_metadata Map attribute is_versioned Boolean attribute
create_storage_entry	create	content String storage_options Map file_name String attribute mime_type String attribute file_size Integer attribute checksum String attribute version String attribute storage_backend Atom attribute storage_metadata Map attribute is_versioned Boolean attribute
store_content	action	content String file_name String storage_backend Atom storage_options Map
retrieve_content	action
delete_content	action
create_version	action	content String version_name String commit_message String
schedule_bulk_processing	action	operation Atom batch_size Integer backend Atom
schedule_maintenance	action	maintenance_type Atom max_age_hours Integer batch_size Integer

Other notebooks:

@DockYard-Academy

curriculum

HTML & CSS

html_css.livemd

jason kino youtube hidden_cell

2023-1-21
aetherus
@Aetherus

advent-of-code

Advent of Code 2024 - Day 24

day-24.livemd

advanced algorithms kino_aoc libgraph kino_vega_lite kino_explorer

2025-6-4
Technology Transformation Services
@GSA-TTS

livebooks

Digital Analytics Program

digital-analytics-program.livemd

tutorial data-science intermediate httpoison jason kino_explorer

2024-1-20
Evan Johnson
@Evanjsta

stepvo-conversation

Authorize Access to Resources

authorize-access-to-resources.livemd

tutorial advanced security ash simple_sat kino

2025-8-28
@DockYard-Academy

curriculum

Fibonacci Sequence

fibonacci_challenge.livemd

tutorial intermediate jason benchee kino youtube hidden_cell

2023-1-21
Membrane Framework
@membraneframework

membrane_rtsp

Basic Server

basic_server.livemd

tutorial advanced gen-server membrane_core membrane_rtsp membrane_rtp_plugin membrane_rtp_h264_plugin membrane_h264_plugin membrane_file_plugin membrane_realtimer_plugin

2024-2-17
Nicolò G.
@nickgnd

gpt-from-scratch-with-nx-...

Let's build GPT: from scratch, in code, spelled ou...

gpt.livemd

tutorial advanced data-science nx axon exla kino

2023-8-7

Back