api.md

Shared

Types:

• AfterIdle
• AgentMount
• AgentSource
• BrokerMount
• CodeMountParameters
• LaunchParameters
• LifecycleConfiguration
• LifecycleHooks
• Mount
• ObjectMount
• ResumeTriggers
• RunProfile

Accounts

Types:

• AccountView

Methods:

• client.accounts.me() -> AccountView

Benchmarks

Types:

• BenchmarkCreateParameters
• BenchmarkScenarioUpdateParameters
• BenchmarkUpdateParameters
• BenchmarkView
• ScenarioDefinitionListView
• StartBenchmarkRunParameters

Methods:

• client.benchmarks.create({ ...params }) -> BenchmarkView
• client.benchmarks.retrieve(id) -> BenchmarkView
• client.benchmarks.update(id, { ...params }) -> BenchmarkView
• client.benchmarks.list({ ...params }) -> BenchmarkViewsBenchmarksCursorIDPage
• client.benchmarks.definitions(id, { ...params }) -> ScenarioDefinitionListView
• client.benchmarks.listPublic({ ...params }) -> BenchmarkViewsBenchmarksCursorIDPage
• client.benchmarks.startRun({ ...params }) -> BenchmarkRunView
• client.benchmarks.updateScenarios(id, { ...params }) -> BenchmarkView

BenchmarkRuns

Types:

• BenchmarkRunListView
• BenchmarkRunView

Methods:

• client.benchmarkRuns.retrieve(id) -> BenchmarkRunView
• client.benchmarkRuns.list({ ...params }) -> BenchmarkRunViewsBenchmarkRunsCursorIDPage
• client.benchmarkRuns.cancel(id) -> BenchmarkRunView
• client.benchmarkRuns.complete(id) -> BenchmarkRunView
• client.benchmarkRuns.listScenarioRuns(id, { ...params }) -> ScenarioRunViewsBenchmarkRunsCursorIDPage

BenchmarkJobs

Types:

• BenchmarkJobCreateParameters
• BenchmarkJobListView
• BenchmarkJobView

Methods:

• client.benchmarkJobs.create({ ...params }) -> BenchmarkJobView
• client.benchmarkJobs.retrieve(id) -> BenchmarkJobView
• client.benchmarkJobs.list({ ...params }) -> BenchmarkJobListView

Agents

Types:

• AgentCreateParameters
• AgentDevboxCountsView
• AgentListView
• AgentView
• AgentDeleteResponse

Methods:

• client.agents.create({ ...params }) -> AgentView
• client.agents.retrieve(id) -> AgentView
• client.agents.list({ ...params }) -> AgentViewsAgentsCursorIDPage
• client.agents.delete(id) -> unknown
• client.agents.devboxCounts() -> AgentDevboxCountsView
• client.agents.listPublic({ ...params }) -> AgentViewsAgentsCursorIDPage

Axons

Types:

• AxonCreateParams
• AxonEventView
• AxonListView
• AxonView
• PublishParams
• PublishResultView

Methods:

• client.axons.create({ ...params }) -> AxonView
• client.axons.retrieve(id) -> AxonView
• client.axons.list({ ...params }) -> AxonViewsAxonsCursorIDPage
• client.axons.publish(id, { ...params }) -> PublishResultView
• client.axons.subscribeSse(id, { ...params }) -> AxonEventView

Events

Types:

• AxonEventListView

Methods:

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

Sql

Types:

• 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:

• BlueprintBuildLog
• BlueprintBuildLogsListView
• BlueprintBuildParameters
• BlueprintListView
• BlueprintPreviewView
• BlueprintView
• BlueprintDeleteResponse

Methods:

• client.blueprints.create({ ...params }) -> BlueprintView
• client.blueprints.retrieve(id) -> BlueprintView
• client.blueprints.list({ ...params }) -> BlueprintViewsBlueprintsCursorIDPage
• client.blueprints.delete(id) -> unknown
• client.blueprints.listPublic({ ...params }) -> BlueprintViewsBlueprintsCursorIDPage
• client.blueprints.logs(id) -> BlueprintBuildLogsListView
• client.blueprints.preview({ ...params }) -> BlueprintPreviewView

Devboxes

Types:

• DevboxAsyncExecutionDetailView
• DevboxExecutionDetailView
• DevboxKillExecutionRequest
• DevboxListView
• DevboxResourceUsageView
• DevboxSendStdInRequest
• DevboxSendStdInResult
• DevboxSnapshotListView
• DevboxSnapshotView
• DevboxView
• PtyTunnelView
• TunnelView
• DevboxCreateSSHKeyResponse
• DevboxDeleteDiskSnapshotResponse
• DevboxKeepAliveResponse
• DevboxReadFileContentsResponse
• DevboxRemoveTunnelResponse
• DevboxUploadFileResponse

Methods:

• client.devboxes.create({ ...params }) -> DevboxView
• client.devboxes.retrieve(id) -> DevboxView
• client.devboxes.update(id, { ...params }) -> DevboxView
• client.devboxes.list({ ...params }) -> DevboxViewsDevboxesCursorIDPage
• client.devboxes.createPtyTunnel(id) -> PtyTunnelView
• client.devboxes.createSSHKey(id) -> DevboxCreateSSHKeyResponse
• client.devboxes.deleteDiskSnapshot(id) -> unknown
• client.devboxes.downloadFile(id, { ...params }) -> Response
• client.devboxes.enableTunnel(id, { ...params }) -> TunnelView
• client.devboxes.execute(id, { ...params }) -> DevboxAsyncExecutionDetailView
• client.devboxes.executeAsync(id, { ...params }) -> DevboxAsyncExecutionDetailView
• client.devboxes.executeSync(id, { ...params }) -> DevboxExecutionDetailView
• client.devboxes.keepAlive(id) -> unknown
• client.devboxes.listDiskSnapshots({ ...params }) -> DevboxSnapshotViewsDiskSnapshotsCursorIDPage
• client.devboxes.readFileContents(id, { ...params }) -> string
• client.devboxes.removeTunnel(id) -> unknown
• client.devboxes.resume(id) -> DevboxView
• client.devboxes.retrieveResourceUsage(id) -> DevboxResourceUsageView
• client.devboxes.shutdown(id, { ...params }) -> DevboxView
• client.devboxes.snapshotDisk(id, { ...params }) -> DevboxSnapshotView
• client.devboxes.snapshotDiskAsync(id, { ...params }) -> DevboxSnapshotView
• client.devboxes.suspend(id) -> DevboxView
• client.devboxes.uploadFile(id, { ...params }) -> unknown
• client.devboxes.waitForCommand(devboxId, executionId, { ...params }) -> DevboxAsyncExecutionDetailView
• client.devboxes.writeFileContents(id, { ...params }) -> DevboxExecutionDetailView

DiskSnapshots

Types:

• DevboxSnapshotAsyncStatusView
• DiskSnapshotDeleteResponse

Methods:

• client.devboxes.diskSnapshots.update(id, { ...params }) -> DevboxSnapshotView
• client.devboxes.diskSnapshots.list({ ...params }) -> DevboxSnapshotViewsDiskSnapshotsCursorIDPage
• client.devboxes.diskSnapshots.delete(id) -> unknown
• client.devboxes.diskSnapshots.queryStatus(id) -> DevboxSnapshotAsyncStatusView

Logs

Types:

• DevboxLogsListView

Methods:

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

Executions

Types:

• ExecutionUpdateChunk

Methods:

• client.devboxes.executions.retrieve(devboxId, executionId, { ...params }) -> DevboxAsyncExecutionDetailView
• client.devboxes.executions.executeAsync(id, { ...params }) -> DevboxAsyncExecutionDetailView
• client.devboxes.executions.executeSync(id, { ...params }) -> DevboxExecutionDetailView
• client.devboxes.executions.kill(devboxId, executionId, { ...params }) -> DevboxAsyncExecutionDetailView
• client.devboxes.executions.sendStdIn(devboxId, executionId, { ...params }) -> DevboxSendStdInResult
• client.devboxes.executions.streamStderrUpdates(devboxId, executionId, { ...params }) -> ExecutionUpdateChunk
• client.devboxes.executions.streamStdoutUpdates(devboxId, executionId, { ...params }) -> ExecutionUpdateChunk

Pty

Types:

• PtyConnectView
• PtyControlParams
• PtyControlResultView

Methods:

• client.pty.connect(sessionName, { ...params }) -> PtyConnectView
• client.pty.control(sessionName, { ...params }) -> PtyControlResultView

Scenarios

Types:

• 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 }) -> ScenarioViewsScenariosCursorIDPage
• client.scenarios.archive(id) -> ScenarioView
• client.scenarios.listPublic({ ...params }) -> ScenarioViewsScenariosCursorIDPage
• client.scenarios.startRun({ ...params }) -> ScenarioRunView

Runs

Methods:

• client.scenarios.runs.retrieve(id) -> ScenarioRunView
• client.scenarios.runs.list({ ...params }) -> ScenarioRunViewsBenchmarkRunsCursorIDPage
• client.scenarios.runs.cancel(id) -> ScenarioRunView
• client.scenarios.runs.complete(id) -> ScenarioRunView
• client.scenarios.runs.downloadLogs(id) -> Response
• client.scenarios.runs.score(id) -> ScenarioRunView

Scorers

Types:

• ScorerCreateResponse
• ScorerRetrieveResponse
• ScorerUpdateResponse
• ScorerListResponse

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 }) -> ScorerListResponsesScenarioScorersCursorIDPage

Objects

Types:

• ObjectCreateParameters
• ObjectDownloadURLView
• ObjectListView
• ObjectView

Methods:

• client.objects.create({ ...params }) -> ObjectView
• client.objects.retrieve(id) -> ObjectView
• client.objects.list({ ...params }) -> ObjectViewsObjectsCursorIDPage
• client.objects.delete(id) -> ObjectView
• client.objects.complete(id) -> ObjectView
• client.objects.download(id, { ...params }) -> ObjectDownloadURLView
• client.objects.listPublic({ ...params }) -> ObjectViewsObjectsCursorIDPage

Secrets

Types:

• 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:

• AllowedCidr
• NetworkPolicyCreateParameters
• NetworkPolicyListView
• NetworkPolicyUpdateParameters
• NetworkPolicyView
• PortRule

Methods:

• client.networkPolicies.create({ ...params }) -> NetworkPolicyView
• client.networkPolicies.retrieve(id) -> NetworkPolicyView
• client.networkPolicies.update(id, { ...params }) -> NetworkPolicyView
• client.networkPolicies.list({ ...params }) -> NetworkPolicyViewsNetworkPoliciesCursorIDPage
• client.networkPolicies.delete(id) -> NetworkPolicyView

GatewayConfigs

Types:

• GatewayConfigCreateParameters
• GatewayConfigListView
• GatewayConfigUpdateParameters
• GatewayConfigView

Methods:

• client.gatewayConfigs.create({ ...params }) -> GatewayConfigView
• client.gatewayConfigs.retrieve(id) -> GatewayConfigView
• client.gatewayConfigs.update(id, { ...params }) -> GatewayConfigView
• client.gatewayConfigs.list({ ...params }) -> GatewayConfigViewsGatewayConfigsCursorIDPage
• client.gatewayConfigs.delete(id) -> GatewayConfigView

McpConfigs

Types:

• McpConfigCreateParameters
• McpConfigListView
• McpConfigUpdateParameters
• McpConfigView

Methods:

• client.mcpConfigs.create({ ...params }) -> McpConfigView
• client.mcpConfigs.retrieve(id) -> McpConfigView
• client.mcpConfigs.update(id, { ...params }) -> McpConfigView
• client.mcpConfigs.list({ ...params }) -> McpConfigViewsMcpConfigsCursorIDPage
• client.mcpConfigs.delete(id) -> McpConfigView

Apikeys

Types:

• APIKeyCreatedView
• APIKeyCreateParameters

Methods:

• client.apikeys.create({ ...params }) -> APIKeyCreatedView

RestrictedKeys

Types:

• RestrictedKeyCreatedView
• RestrictedKeyCreateParameters
• ScopeEntryView

Methods:

• client.restrictedKeys.create({ ...params }) -> RestrictedKeyCreatedView