Resource handles¶

These are generated resource entry points used by the convenience client. A resource handle stores identity; calls perform network work. The native gateway remains separate from native Desktop HTTP.

The full generated resource module also contains individual native subsystems. Use the runtime's supported contract when calling those methods.

RootResource ¶

RootResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

instances `property` ¶

instances: InstancesResource

pools `property` ¶

pools: PoolsResource

jobs `property` ¶

jobs: JobsResource

images `property` ¶

images: ImagesResource

tools `property` ¶

tools: ToolsResource

inference `property` ¶

inference: InferenceResource

capabilities `async` ¶

capabilities() -> (
    _types_control_plane.ControlPlaneCapabilities
)

InstancesResource ¶

InstancesResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

list `async` ¶

list(
    *,
    cursor: str | Unset = UNSET,
    limit: int | Unset = UNSET,
    owner_id: str | Unset = UNSET,
    pool_id: str | Unset = UNSET,
    status: InstanceStatus | Unset = UNSET,
) -> _types_control_plane.InstancePage

create `async` ¶

create(
    *,
    idempotency_key: str | Unset = UNSET,
    owner: OwnerReference,
    name: str,
    runtime: RuntimeSpec,
    pool_id: str | Unset = UNSET,
    labels: dict[str, str] | Unset = UNSET,
    bootstrap: BootstrapSpec | Unset = UNSET,
    extra_body: Mapping[str, Any] | None = None,
) -> _types_control_plane.InstanceOperation

InstanceResource ¶

InstanceResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

profiles `property` ¶

profiles: ProfilesResource

get `async` ¶

get() -> _types_control_plane.Instance

update `async` ¶

update(
    *,
    if_match: str,
    name: str | Unset = UNSET,
    desired_state: DesiredState | Unset = UNSET,
    labels: dict[str, str] | Unset = UNSET,
    runtime: RuntimeSpec | Unset = UNSET,
    extra_body: Mapping[str, Any] | None = None,
) -> _types_control_plane.Instance

delete `async` ¶

delete(
    *, retain_data: bool | Unset = UNSET
) -> _types_control_plane.InstanceOperation

action `async` ¶

action(
    *,
    action: Literal[
        "start", "stop", "restart", "reconcile"
    ],
    idempotency_key: str | Unset = UNSET,
) -> _types_control_plane.InstanceOperation

connection `async` ¶

connection() -> _types_control_plane.ConnectionDescriptor

capabilities `async` ¶

capabilities() -> _types_control_plane.CapabilityDocument

runtime_capabilities `async` ¶

runtime_capabilities() -> (
    _types_runtime.RuntimeCapabilities
)

ProfilesResource ¶

ProfilesResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

list `async` ¶

list() -> _types_control_plane.listProfilesResult

create `async` ¶

create(
    *,
    name: str,
    description: str | Unset = UNSET,
    clone_from: str | Unset = UNSET,
    clone_all: bool | Unset = UNSET,
    clone_channels: bool | Unset = UNSET,
    include_skills: bool | Unset = UNSET,
    soul: str | Unset = UNSET,
    model: str | Unset = UNSET,
    provider: str | Unset = UNSET,
    mirror_credentials: bool | Unset = UNSET,
    config: dict[str, Any] | Unset = UNSET,
    extra_body: Mapping[str, Any] | None = None,
) -> _types_control_plane.Profile

ProfileResource ¶

ProfileResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

sessions `property` ¶

sessions: SessionsResource

native `property` ¶

native: NativeResource

providers `property` ¶

providers: ProvidersResource

get `async` ¶

get() -> _types_control_plane.Profile

update `async` ¶

update(
    *,
    description: str | Unset = UNSET,
    soul: str | Unset = UNSET,
    model: str | Unset = UNSET,
    provider: str | Unset = UNSET,
    config: dict[str, Any] | Unset = UNSET,
    extra_body: Mapping[str, Any] | None = None,
) -> _types_control_plane.Profile

delete `async` ¶

delete() -> Any

request `async` ¶

request(
    *,
    jsonrpc: Literal["2.0"],
    id: Union[str, int, None] | Unset = UNSET,
    method: str,
    params: Union[dict[str, Any], list[Any]]
    | Unset = UNSET,
    extra_body: Mapping[str, Any] | None = None,
) -> _types_runtime.JsonRpcResponse

connect ¶

connect() -> AbstractAsyncContextManager[NativeConnection]

SessionsResource ¶

SessionsResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

list `async` ¶

list(
    *, cursor: str | Unset = UNSET
) -> _types_runtime.SessionPage

create `async` ¶

create(
    *,
    idempotency_key: str | Unset = UNSET,
    title: str | Unset = UNSET,
    resume_native_session_id: str | Unset = UNSET,
    working_directory: str | Unset = UNSET,
    environment: dict[str, str] | Unset = UNSET,
    metadata: dict[str, Any] | Unset = UNSET,
    tool_binding_ids: list[str] | Unset = UNSET,
    extra_body: Mapping[str, Any] | None = None,
) -> _types_runtime.Session

SessionResource ¶

SessionResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

turns `property` ¶

turns: TurnsResource

get `async` ¶

get() -> _types_runtime.Session

delete `async` ¶

delete() -> Any

action `async` ¶

action(*, body: SessionAction) -> _types_runtime.Session

events ¶

events(
    *, after: str | Unset = UNSET
) -> AsyncIterator[dict[str, Any]]

TurnsResource ¶

TurnsResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

submit `async` ¶

submit(
    *,
    idempotency_key: str | Unset = UNSET,
    content: Union[str, list[ContentPart]],
    mode: Literal["enqueue", "steer"] | Unset = UNSET,
    tool_binding_ids: list[str] | Unset = UNSET,
    metadata: dict[str, Any] | Unset = UNSET,
    extra_body: Mapping[str, Any] | None = None,
) -> _types_runtime.Turn

TurnResource ¶

TurnResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

get `async` ¶

get() -> _types_runtime.Turn

action `async` ¶

action(*, body: TurnAction) -> Any

wait `async` ¶

wait(
    *, timeout: float = 300, poll_interval: float = 0.5
) -> _types_runtime.Turn

stop `async` ¶

stop() -> Any

steer `async` ¶

steer(content: str) -> Any

approve `async` ¶

approve(
    request_id: str,
    decision: Literal[
        "allow_once", "allow_session", "deny"
    ],
) -> Any

BindingResource ¶

BindingResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

get `async` ¶

get() -> _types_tools.ToolBinding

delete `async` ¶

delete() -> Any

NativeResource ¶

NativeResource(sdk: AsyncEdithHermes, **scope: str)

Bases: Resource

agents `property` ¶

agents: NativeAgentsResource

approval `property` ¶

approval: NativeApprovalResource

billing `property` ¶

billing: NativeBillingResource

bot_relay `property` ¶

bot_relay: NativeBotRelayResource

browser `property` ¶

browser: NativeBrowserResource

clarify `property` ¶

clarify: NativeClarifyResource

cli `property` ¶

cli: NativeCliResource

client `property` ¶

client: NativeClientResource

clipboard `property` ¶

clipboard: NativeClipboardResource

command `property` ¶

command: NativeCommandResource

commands `property` ¶

commands: NativeCommandsResource

complete `property` ¶

complete: NativeCompleteResource

config `property` ¶

config: NativeConfigResource

connection `property` ¶

connection: NativeConnectionResource

connectors `property` ¶

connectors: NativeConnectorsResource

cron `property` ¶

cron: NativeCronResource

delegation `property` ¶

delegation: NativeDelegationResource

diagnostics `property` ¶

diagnostics: NativeDiagnosticsResource

file `property` ¶

file: NativeFileResource

free_tier `property` ¶

free_tier: NativeFreeTierResource

gateway `property` ¶

gateway: NativeGatewayResource

groups `property` ¶

groups: NativeGroupsResource

handoff `property` ¶

handoff: NativeHandoffResource

image `property` ¶

image: NativeImageResource

input `property` ¶

input: NativeInputResource

insights `property` ¶

insights: NativeInsightsResource

learning `property` ¶

learning: NativeLearningResource

llm `property` ¶

llm: NativeLlmResource

mcp `property` ¶

mcp: NativeMcpResource

message `property` ¶

message: NativeMessageResource

model `property` ¶

model: NativeModelResource

paste `property` ¶

paste: NativePasteResource

pdf `property` ¶

pdf: NativePdfResource

pet `property` ¶

pet: NativePetResource

plugins `property` ¶

plugins: NativePluginsResource

preview `property` ¶

preview: NativePreviewResource

process `property` ¶

process: NativeProcessResource

profiles `property` ¶

profiles: NativeProfilesResource

project `property` ¶

project: NativeProjectResource

projects `property` ¶

projects: NativeProjectsResource

prompt `property` ¶

prompt: NativePromptResource

reload `property` ¶

reload: NativeReloadResource

request `property` ¶

request: NativeRequestResource

rollback `property` ¶

rollback: NativeRollbackResource

session `property` ¶

session: NativeSessionResource

setup `property` ¶

setup: NativeSetupResource

shell `property` ¶

shell: NativeShellResource

skills `property` ¶

skills: NativeSkillsResource

slash `property` ¶

slash: NativeSlashResource

spawn_tree `property` ¶

spawn_tree: NativeSpawnTreeResource

subagent `property` ¶

subagent: NativeSubagentResource

subscription `property` ¶

subscription: NativeSubscriptionResource

system `property` ¶

system: NativeSystemResource

terminal `property` ¶

terminal: NativeTerminalResource

tools `property` ¶

tools: NativeToolsResource

toolsets `property` ¶

toolsets: NativeToolsetsResource

usage `property` ¶

usage: NativeUsageResource

vault `property` ¶

vault: NativeVaultResource

verification `property` ¶

verification: NativeVerificationResource

voice `property` ¶

voice: NativeVoiceResource

wake `property` ¶

wake: NativeWakeResource

ping `async` ¶

ping(
    *, extra_params: Mapping[str, Any] | None = None
) -> _types_native.PingResult

Cheapest liveness probe; answered on the WS reader thread even while every agent is mid-turn.

Resource handles¶

RootResource ¶

instances property ¶

pools property ¶

jobs property ¶

images property ¶

tools property ¶

inference property ¶

capabilities async ¶

InstancesResource ¶

list async ¶

create async ¶

InstanceResource ¶

profiles property ¶

get async ¶

update async ¶

delete async ¶

action async ¶

connection async ¶

capabilities async ¶

runtime_capabilities async ¶

ProfilesResource ¶

list async ¶

create async ¶

ProfileResource ¶

sessions property ¶

native property ¶

providers property ¶

get async ¶

update async ¶

delete async ¶

request async ¶

connect ¶

SessionsResource ¶

list async ¶

create async ¶

SessionResource ¶

turns property ¶

get async ¶

delete async ¶

action async ¶

events ¶

TurnsResource ¶

submit async ¶

TurnResource ¶

get async ¶

action async ¶

wait async ¶

stop async ¶

steer async ¶

approve async ¶

BindingResource ¶

get async ¶

delete async ¶

NativeResource ¶

agents property ¶

approval property ¶

billing property ¶

bot_relay property ¶

browser property ¶

clarify property ¶

cli property ¶

client property ¶

clipboard property ¶

command property ¶

commands property ¶

complete property ¶

config property ¶

connection property ¶

connectors property ¶

cron property ¶

delegation property ¶

diagnostics property ¶

file property ¶

free_tier property ¶

gateway property ¶

groups property ¶

handoff property ¶

image property ¶

input property ¶

instances `property` ¶

pools `property` ¶

jobs `property` ¶

images `property` ¶

tools `property` ¶

inference `property` ¶

capabilities `async` ¶

list `async` ¶

create `async` ¶

profiles `property` ¶

get `async` ¶

update `async` ¶

delete `async` ¶

action `async` ¶

connection `async` ¶

capabilities `async` ¶

runtime_capabilities `async` ¶

list `async` ¶

create `async` ¶

sessions `property` ¶

native `property` ¶

providers `property` ¶

get `async` ¶

update `async` ¶

delete `async` ¶

request `async` ¶

list `async` ¶

create `async` ¶

turns `property` ¶

get `async` ¶

delete `async` ¶

action `async` ¶

submit `async` ¶

get `async` ¶

action `async` ¶

wait `async` ¶

stop `async` ¶

steer `async` ¶

approve `async` ¶

get `async` ¶

delete `async` ¶

agents `property` ¶

approval `property` ¶

billing `property` ¶

bot_relay `property` ¶

browser `property` ¶

clarify `property` ¶

cli `property` ¶

client `property` ¶

clipboard `property` ¶

command `property` ¶

commands `property` ¶

complete `property` ¶

config `property` ¶

connection `property` ¶

connectors `property` ¶

cron `property` ¶

delegation `property` ¶

diagnostics `property` ¶

file `property` ¶

free_tier `property` ¶

gateway `property` ¶

groups `property` ¶

handoff `property` ¶

image `property` ¶

input `property` ¶

insights `property` ¶

learning `property` ¶

llm `property` ¶

mcp `property` ¶

message `property` ¶

model `property` ¶

paste `property` ¶

pdf `property` ¶

pet `property` ¶

plugins `property` ¶

preview `property` ¶

process `property` ¶

profiles `property` ¶

project `property` ¶