api.md

Workspaces

Types:

from dedalus_sdk.types import CreateParams, LifecycleStatus, UpdateParams, Workspace, WorkspaceList

Methods:

• client.workspaces.create(**params) -> Workspace
• client.workspaces.retrieve(workspace_id) -> Workspace
• client.workspaces.update(workspace_id, **params) -> Workspace
• client.workspaces.list(**params) -> SyncCursorPage[Item]
• client.workspaces.delete(workspace_id) -> Workspace

Artifacts

Types:

from dedalus_sdk.types.workspaces import Artifact, ArtifactList

Methods:

• client.workspaces.artifacts.retrieve(artifact_id, *, workspace_id) -> Artifact
• client.workspaces.artifacts.list(workspace_id, **params) -> SyncCursorPage[Artifact]
• client.workspaces.artifacts.delete(artifact_id, *, workspace_id) -> Artifact

Previews

Types:

from dedalus_sdk.types.workspaces import Preview, PreviewCreateParams, PreviewList

Methods:

• client.workspaces.previews.create(workspace_id, **params) -> Preview
• client.workspaces.previews.retrieve(preview_id, *, workspace_id) -> Preview
• client.workspaces.previews.list(workspace_id, **params) -> SyncCursorPage[Preview]
• client.workspaces.previews.delete(preview_id, *, workspace_id) -> Preview

SSH

Types:

from dedalus_sdk.types.workspaces import (
    SSHConnection,
    SSHHostTrust,
    SSHSession,
    SSHSessionCreateParams,
    SSHSessionList,
)

Methods:

• client.workspaces.ssh.create(workspace_id, **params) -> SSHSession
• client.workspaces.ssh.retrieve(session_id, *, workspace_id) -> SSHSession
• client.workspaces.ssh.list(workspace_id, **params) -> SyncCursorPage[SSHSession]
• client.workspaces.ssh.delete(session_id, *, workspace_id) -> SSHSession

Executions

Types:

from dedalus_sdk.types.workspaces import (
    ArtifactRef,
    Execution,
    ExecutionCreateParams,
    ExecutionEvent,
    ExecutionEvents,
    ExecutionList,
    ExecutionOutput,
)

Methods:

• client.workspaces.executions.create(workspace_id, **params) -> Execution
• client.workspaces.executions.retrieve(execution_id, *, workspace_id) -> Execution
• client.workspaces.executions.list(workspace_id, **params) -> SyncCursorPage[Execution]
• client.workspaces.executions.delete(execution_id, *, workspace_id) -> Execution
• client.workspaces.executions.events(execution_id, *, workspace_id, **params) -> SyncCursorPage[ExecutionEvent]
• client.workspaces.executions.output(execution_id, *, workspace_id) -> ExecutionOutput

Terminals

Types:

from dedalus_sdk.types.workspaces import (
    Terminal,
    TerminalClientEvent,
    TerminalClosedEvent,
    TerminalCreateParams,
    TerminalErrorEvent,
    TerminalInputEvent,
    TerminalList,
    TerminalOutputEvent,
    TerminalResizeEvent,
    TerminalServerEvent,
)

Methods:

• client.workspaces.terminals.create(workspace_id, **params) -> Terminal
• client.workspaces.terminals.retrieve(terminal_id, *, workspace_id) -> Terminal
• client.workspaces.terminals.list(workspace_id, **params) -> SyncCursorPage[Terminal]
• client.workspaces.terminals.delete(terminal_id, *, workspace_id) -> Terminal