api.md

Shared Types

from runloop_api_client.types import (
    AfterIdle,
    AgentMount,
    AgentSource,
    AuthMechanism,
    BrokerMount,
    CodeMountParameters,
    CustomHeader,
    LaunchParameters,
    LifecycleConfiguration,
    LifecycleHooks,
    Mount,
    ObjectMount,
    ResumeTriggers,
)

Accounts

Types:

from runloop_api_client.types import AccountView

Methods:

• client.accounts.me() -> AccountView

Agents

Types:

from runloop_api_client.types import (
    AgentCreateParameters,
    AgentDevboxCountsView,
    AgentListView,
    AgentView,
)

Methods:

• client.agents.create(**params) -> AgentView
• client.agents.retrieve(id) -> AgentView
• client.agents.list(**params) -> SyncAgentsCursorIDPage[AgentView]
• client.agents.delete(id) -> object
• client.agents.devbox_counts() -> AgentDevboxCountsView
• client.agents.list_public(**params) -> SyncAgentsCursorIDPage[AgentView]

Axons

Types:

from runloop_api_client.types import (
    AxonCreateParams,
    AxonEventView,
    AxonListView,
    AxonUpdateParams,
    AxonView,
    PublishParams,
    PublishResultView,
)

Methods:

• client.axons.create(**params) -> AxonView
• client.axons.retrieve(id) -> AxonView
• client.axons.update(id, **params) -> AxonView
• client.axons.list(**params) -> SyncAxonsCursorIDPage[AxonView]
• client.axons.delete(id) -> object
• client.axons.publish(id, **params) -> PublishResultView
• client.axons.subscribe_sse(id, **params) -> AxonEventView

Events

Types:

from runloop_api_client.types.axons import AxonEventListView

Methods:

• client.axons.events.list(id, **params) -> AxonEventListView

Sql

Types:

from runloop_api_client.types.axons import (
    SqlBatchParams,
    SqlBatchResultView,
    SqlColumnMetaView,
    SqlQueryResultView,
    SqlResultMetaView,
    SqlStatementParams,
    SqlStepErrorView,
    SqlStepResultView,
)

Methods:

• client.axons.sql.batch(id, **params) -> SqlBatchResultView
• client.axons.sql.query(id, **params) -> SqlQueryResultView

Blueprints

Types:

from runloop_api_client.types import (
    BlueprintBuildLog,
    BlueprintBuildLogsListView,
    BlueprintBuildParameters,
    BlueprintListView,
    BlueprintPreviewView,
    BlueprintView,
)

Methods:

• client.blueprints.create(**params) -> BlueprintView
• client.blueprints.create_and_await_build_complete(**params) -> BlueprintView
• client.blueprints.retrieve(id) -> BlueprintView
• client.blueprints.list(**params) -> SyncBlueprintsCursorIDPage[BlueprintView]
• client.blueprints.delete(id) -> object
• client.blueprints.list_public(**params) -> SyncBlueprintsCursorIDPage[BlueprintView]
• client.blueprints.logs(id) -> BlueprintBuildLogsListView
• client.blueprints.preview(**params) -> BlueprintPreviewView

Devboxes

Types:

from runloop_api_client.types import (
    DevboxAsyncExecutionDetailView,
    DevboxEvictionEventView,
    DevboxExecutionDetailView,
    DevboxKillExecutionRequest,
    DevboxListView,
    DevboxResourceUsageView,
    DevboxSendStdInRequest,
    DevboxSendStdInResult,
    DevboxSnapshotListView,
    DevboxSnapshotView,
    DevboxView,
    GatewayTokenView,
    McpTokenView,
    PtyTunnelView,
    TunnelView,
    DevboxCreateSSHKeyResponse,
    DevboxReadFileContentsResponse,
)

Methods:

• client.devboxes.create(**params) -> DevboxView
• client.devboxes.create_and_await_running(**params) -> DevboxView
• client.devboxes.retrieve(id) -> DevboxView
• client.devboxes.update(id, **params) -> DevboxView
• client.devboxes.list(**params) -> SyncDevboxesCursorIDPage[DevboxView]
• client.devboxes.create_gateway_token(id, **params) -> GatewayTokenView
• client.devboxes.create_mcp_token(id, **params) -> McpTokenView
• client.devboxes.create_pty_tunnel(id) -> PtyTunnelView
• client.devboxes.create_ssh_key(id) -> DevboxCreateSSHKeyResponse
• client.devboxes.delete_disk_snapshot(id) -> object
• client.devboxes.download_file(id, **params) -> BinaryAPIResponse
• client.devboxes.enable_tunnel(id, **params) -> TunnelView
• client.devboxes.execute(id, **params) -> DevboxAsyncExecutionDetailView
• client.devboxes.execute_async(id, **params) -> DevboxAsyncExecutionDetailView
• client.devboxes.execute_sync(id, **params) -> DevboxExecutionDetailView
• client.devboxes.keep_alive(id) -> object
• client.devboxes.list_disk_snapshots(**params) -> SyncDiskSnapshotsCursorIDPage[DevboxSnapshotView]
• client.devboxes.read_file_contents(id, **params) -> str
• client.devboxes.remove_tunnel(id) -> object
• client.devboxes.resume(id) -> DevboxView
• client.devboxes.retrieve_resource_usage(id) -> DevboxResourceUsageView
• client.devboxes.shutdown(id, **params) -> DevboxView
• client.devboxes.snapshot_disk(id, **params) -> DevboxSnapshotView
• client.devboxes.snapshot_disk_async(id, **params) -> DevboxSnapshotView
• client.devboxes.suspend(id) -> DevboxView
• client.devboxes.upload_file(id, **params) -> object
• client.devboxes.wait_for_command(execution_id, *, devbox_id, **params) -> DevboxAsyncExecutionDetailView
• client.devboxes.watch_evictions() -> DevboxEvictionEventView
• client.devboxes.write_file_contents(id, **params) -> DevboxExecutionDetailView

DiskSnapshots

Types:

from runloop_api_client.types.devboxes import DevboxSnapshotAsyncStatusView

Methods:

• client.devboxes.disk_snapshots.update(id, **params) -> DevboxSnapshotView
• client.devboxes.disk_snapshots.list(**params) -> SyncDiskSnapshotsCursorIDPage[DevboxSnapshotView]
• client.devboxes.disk_snapshots.delete(id) -> object
• client.devboxes.disk_snapshots.query_status(id) -> DevboxSnapshotAsyncStatusView

Logs

Types:

from runloop_api_client.types.devboxes import DevboxLogsListView

Methods:

• client.devboxes.logs.list(id, **params) -> DevboxLogsListView

Executions

Types:

from runloop_api_client.types.devboxes import ExecutionUpdateChunk

Methods:

• client.devboxes.executions.retrieve(execution_id, *, devbox_id, **params) -> DevboxAsyncExecutionDetailView
• client.devboxes.executions.execute_async(id, **params) -> DevboxAsyncExecutionDetailView
• client.devboxes.executions.execute_sync(id, **params) -> DevboxExecutionDetailView
• client.devboxes.executions.kill(execution_id, *, devbox_id, **params) -> DevboxAsyncExecutionDetailView
• client.devboxes.executions.send_std_in(execution_id, *, devbox_id, **params) -> DevboxSendStdInResult
• client.devboxes.executions.stream_stderr_updates(execution_id, *, devbox_id, **params) -> ExecutionUpdateChunk
• client.devboxes.executions.stream_stdout_updates(execution_id, *, devbox_id, **params) -> ExecutionUpdateChunk

Pty

Types:

from runloop_api_client.types import PtyConnectView, PtyControlParams, PtyControlResultView

Methods:

• client.pty.connect(session_name, **params) -> PtyConnectView
• client.pty.control(session_name, **params) -> PtyControlResultView

Objects

Types:

from runloop_api_client.types import (
    ObjectCreateParameters,
    ObjectDownloadURLView,
    ObjectListView,
    ObjectView,
)

Methods:

• client.objects.create(**params) -> ObjectView
• client.objects.retrieve(id) -> ObjectView
• client.objects.list(**params) -> SyncObjectsCursorIDPage[ObjectView]
• client.objects.delete(id) -> ObjectView
• client.objects.complete(id) -> ObjectView
• client.objects.download(id, **params) -> ObjectDownloadURLView
• client.objects.list_public(**params) -> SyncObjectsCursorIDPage[ObjectView]

Secrets

Types:

from runloop_api_client.types import (
    SecretCreateParameters,
    SecretListView,
    SecretUpdateParameters,
    SecretView,
)

Methods:

• client.secrets.create(**params) -> SecretView
• client.secrets.retrieve(name) -> SecretView
• client.secrets.update(name, **params) -> SecretView
• client.secrets.list(**params) -> SecretListView
• client.secrets.delete(name) -> SecretView

NetworkPolicies

Types:

from runloop_api_client.types import (
    AllowedCidr,
    NetworkPolicyCreateParameters,
    NetworkPolicyListView,
    NetworkPolicyUpdateParameters,
    NetworkPolicyView,
    PortRule,
)

Methods:

• client.network_policies.create(**params) -> NetworkPolicyView
• client.network_policies.retrieve(id) -> NetworkPolicyView
• client.network_policies.update(id, **params) -> NetworkPolicyView
• client.network_policies.list(**params) -> SyncNetworkPoliciesCursorIDPage[NetworkPolicyView]
• client.network_policies.delete(id) -> NetworkPolicyView

GatewayConfigs

Types:

from runloop_api_client.types import (
    GatewayConfigCreateParameters,
    GatewayConfigListView,
    GatewayConfigUpdateParameters,
    GatewayConfigView,
)

Methods:

• client.gateway_configs.create(**params) -> GatewayConfigView
• client.gateway_configs.retrieve(id) -> GatewayConfigView
• client.gateway_configs.update(id, **params) -> GatewayConfigView
• client.gateway_configs.list(**params) -> SyncGatewayConfigsCursorIDPage[GatewayConfigView]
• client.gateway_configs.delete(id) -> GatewayConfigView

McpConfigs

Types:

from runloop_api_client.types import (
    McpConfigCreateParameters,
    McpConfigListView,
    McpConfigUpdateParameters,
    McpConfigView,
)

Methods:

• client.mcp_configs.create(**params) -> McpConfigView
• client.mcp_configs.retrieve(id) -> McpConfigView
• client.mcp_configs.update(id, **params) -> McpConfigView
• client.mcp_configs.list(**params) -> SyncMcpConfigsCursorIDPage[McpConfigView]
• client.mcp_configs.delete(id) -> McpConfigView

Apikeys

Types:

from runloop_api_client.types import APIKeyCreatedView, APIKeyCreateParameters

Methods:

• client.apikeys.create(**params) -> APIKeyCreatedView

RestrictedKeys

Types:

from runloop_api_client.types import (
    RestrictedKeyCreatedView,
    RestrictedKeyCreateParameters,
    ScopeEntryView,
)

Methods:

• client.restricted_keys.create(**params) -> RestrictedKeyCreatedView