api.md

Shared Types

from runloop_api_client.types import AfterIdle, CodeMountParameters, LaunchParameters, RunProfile

Benchmarks

Types:

from runloop_api_client.types import (
    BenchmarkCreateParameters,
    BenchmarkRunListView,
    BenchmarkRunView,
    BenchmarkView,
    ScenarioDefinitionListView,
    StartBenchmarkRunParameters,
)

Methods:

• client.benchmarks.create(**params) -> BenchmarkView
• client.benchmarks.retrieve(id) -> BenchmarkView
• client.benchmarks.update(id, **params) -> BenchmarkView
• client.benchmarks.list(**params) -> SyncBenchmarksCursorIDPage[BenchmarkView]
• client.benchmarks.definitions(id, **params) -> ScenarioDefinitionListView
• client.benchmarks.list_public(**params) -> SyncBenchmarksCursorIDPage[BenchmarkView]
• client.benchmarks.start_run(**params) -> BenchmarkRunView

Runs

Methods:

• client.benchmarks.runs.retrieve(id) -> BenchmarkRunView
• client.benchmarks.runs.list(**params) -> SyncBenchmarkRunsCursorIDPage[BenchmarkRunView]
• client.benchmarks.runs.cancel(id) -> BenchmarkRunView
• client.benchmarks.runs.complete(id) -> BenchmarkRunView
• client.benchmarks.runs.list_scenario_runs(id, **params) -> SyncBenchmarkRunsCursorIDPage[ScenarioRunView]

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,
    DevboxExecutionDetailView,
    DevboxListView,
    DevboxSnapshotListView,
    DevboxSnapshotView,
    DevboxTunnelView,
    DevboxView,
    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_ssh_key(id) -> DevboxCreateSSHKeyResponse
• client.devboxes.create_tunnel(id, **params) -> DevboxTunnelView
• client.devboxes.delete_disk_snapshot(id) -> object
• client.devboxes.download_file(id, **params) -> BinaryAPIResponse
• 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, **params) -> object
• client.devboxes.resume(id) -> DevboxView
• client.devboxes.shutdown(id) -> 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.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

Browsers

Types:

from runloop_api_client.types.devboxes import BrowserView

Methods:

• client.devboxes.browsers.create(**params) -> BrowserView
• client.devboxes.browsers.retrieve(id) -> BrowserView

Computers

Types:

from runloop_api_client.types.devboxes import (
    ComputerView,
    ComputerKeyboardInteractionResponse,
    ComputerMouseInteractionResponse,
    ComputerScreenInteractionResponse,
)

Methods:

• client.devboxes.computers.create(**params) -> ComputerView
• client.devboxes.computers.retrieve(id) -> ComputerView
• client.devboxes.computers.keyboard_interaction(id, **params) -> ComputerKeyboardInteractionResponse
• client.devboxes.computers.mouse_interaction(id, **params) -> ComputerMouseInteractionResponse
• client.devboxes.computers.screen_interaction(id, **params) -> ComputerScreenInteractionResponse

Lsp

Types:

from runloop_api_client.types.devboxes import (
    BaseCodeAction,
    BaseCommand,
    BaseDiagnostic,
    BaseLocation,
    BaseMarkupContent,
    BaseParameterInformation,
    BaseRange,
    BaseSignature,
    BaseWorkspaceEdit,
    CodeActionApplicationResult,
    CodeActionContext,
    CodeActionKind,
    CodeActionsForDiagnosticRequestBody,
    CodeActionsRequestBody,
    CodeActionsResponse,
    CodeActionTriggerKind,
    CodeDescription,
    CodeSegmentInfoRequestBody,
    CodeSegmentInfoResponse,
    Diagnostic,
    DiagnosticRelatedInformation,
    DiagnosticSeverity,
    DiagnosticsResponse,
    DiagnosticTag,
    DocumentSymbol,
    DocumentSymbolResponse,
    DocumentUri,
    FileContentsResponse,
    FileDefinitionRequestBody,
    FileDefinitionResponse,
    FilePath,
    FileRequestBody,
    FileUri,
    FormattingResponse,
    HealthStatusResponse,
    Integer,
    Location,
    LSpAny,
    Position,
    Range,
    RecordStringTextEditArray,
    ReferencesRequestBody,
    ReferencesResponse,
    SetWatchDirectoryRequestBody,
    SignatureHelpRequestBody,
    SignatureHelpResponse,
    SymbolKind,
    SymbolTag,
    SymbolType,
    TextEdit,
    Uinteger,
    URi,
    WatchedFileResponse,
    LspFilesResponse,
    LspGetCodeActionsForDiagnosticResponse,
    LspSetWatchDirectoryResponse,
)

Methods:

• client.devboxes.lsp.apply_code_action(id, **params) -> CodeActionApplicationResult
• client.devboxes.lsp.code_actions(id, **params) -> CodeActionsResponse
• client.devboxes.lsp.diagnostics(id, **params) -> DiagnosticsResponse
• client.devboxes.lsp.document_symbols(id, **params) -> DocumentSymbolResponse
• client.devboxes.lsp.file(id, **params) -> FileContentsResponse
• client.devboxes.lsp.file_definition(id, **params) -> FileDefinitionResponse
• client.devboxes.lsp.files(id) -> LspFilesResponse
• client.devboxes.lsp.formatting(id, **params) -> FormattingResponse
• client.devboxes.lsp.get_code_actions_for_diagnostic(id, **params) -> LspGetCodeActionsForDiagnosticResponse
• client.devboxes.lsp.get_code_segment_info(id, **params) -> CodeSegmentInfoResponse
• client.devboxes.lsp.get_signature_help(id, **params) -> SignatureHelpResponse
• client.devboxes.lsp.health(id) -> HealthStatusResponse
• client.devboxes.lsp.references(id, **params) -> ReferencesResponse
• client.devboxes.lsp.set_watch_directory(id, **params) -> str

Logs

Types:

from runloop_api_client.types.devboxes import DevboxLogsListView

Methods:

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

Executions

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) -> DevboxAsyncExecutionDetailView

Scenarios

Types:

from runloop_api_client.types import (
    InputContext,
    InputContextUpdate,
    ScenarioCreateParameters,
    ScenarioEnvironment,
    ScenarioRunListView,
    ScenarioRunView,
    ScenarioUpdateParameters,
    ScenarioView,
    ScoringContract,
    ScoringContractResultView,
    ScoringContractUpdate,
    ScoringFunction,
    ScoringFunctionResultView,
    StartScenarioRunParameters,
)

Methods:

• client.scenarios.create(**params) -> ScenarioView
• client.scenarios.retrieve(id) -> ScenarioView
• client.scenarios.update(id, **params) -> ScenarioView
• client.scenarios.list(**params) -> SyncScenariosCursorIDPage[ScenarioView]
• client.scenarios.list_public(**params) -> SyncScenariosCursorIDPage[ScenarioView]
• client.scenarios.start_run(**params) -> ScenarioRunView

Runs

Methods:

• client.scenarios.runs.retrieve(id) -> ScenarioRunView
• client.scenarios.runs.list(**params) -> SyncBenchmarkRunsCursorIDPage[ScenarioRunView]
• client.scenarios.runs.cancel(id) -> ScenarioRunView
• client.scenarios.runs.complete(id) -> ScenarioRunView
• client.scenarios.runs.download_logs(id) -> BinaryAPIResponse
• client.scenarios.runs.score(id) -> ScenarioRunView

Scorers

Types:

from runloop_api_client.types.scenarios import (
    ScorerCreateResponse,
    ScorerRetrieveResponse,
    ScorerUpdateResponse,
    ScorerListResponse,
    ScorerValidateResponse,
)

Methods:

• client.scenarios.scorers.create(**params) -> ScorerCreateResponse
• client.scenarios.scorers.retrieve(id) -> ScorerRetrieveResponse
• client.scenarios.scorers.update(id, **params) -> ScorerUpdateResponse
• client.scenarios.scorers.list(**params) -> SyncScenarioScorersCursorIDPage[ScorerListResponse]
• client.scenarios.scorers.validate(id, **params) -> ScorerValidateResponse

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]

Repositories

Types:

from runloop_api_client.types import (
    RepositoryConnectionListView,
    RepositoryConnectionView,
    RepositoryInspectionDetails,
    RepositoryInspectionListView,
    RepositoryManifestView,
)

Methods:

• client.repositories.create(**params) -> RepositoryConnectionView
• client.repositories.retrieve(id) -> RepositoryConnectionView
• client.repositories.list(**params) -> SyncRepositoriesCursorIDPage[RepositoryConnectionView]
• client.repositories.delete(id) -> object
• client.repositories.list_inspections(id) -> RepositoryInspectionListView
• client.repositories.refresh(id, **params) -> object

Secrets

Types:

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

Methods:

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