SDK method reference

Generated from the OpenAPI contract. All 179 public operations have a resource method. Start with the language guides for installation, authentication, and runnable examples.

Names below follow each language's casing. TypeScript, Python, and Go use resource properties; Java and Rust use resource accessors, such as client.workspaces().create(...). Rust network methods are async. Signatures and response types are available in editor completion and checked-in generated sources; query/header options use typed parameter classes in Go, Rust, and Java. Python uses keyword arguments; TypeScript uses typed options.

Path identifiers are positional. Required request values stay typed; optional transport settings expose idempotency, cancellation, and organization selection where supported. Methods retain each SDK's documented transport behavior. The run events method delegates to resumable incremental streaming; stream remains available. Closing a stream leaves the remote run active; call runs.cancel to stop it.

Streaming and run convenience helpers

These compose existing operations and add no backend endpoints.

Purpose	TypeScript / Java	Python / Rust	Go
Direct model events and saved terminal result	`inferences.stream`	`inferences.stream`	`Inferences.Stream`
Assistant text fragments	`runs.streamText`	`runs.stream_text`	`Runs.StreamText`
Typed complete result after execution and persistence	`runs.wait`	`runs.wait`	`Runs.Wait`

Direct inference helpers set stream: true and deliver typed events through iterators (TypeScript/Python) or callbacks (Go/Rust/Java). They do not reconnect or replay tokens. Inspect terminal events for execution failure; detaching leaves the remote call running. See streaming and each language guide for complete examples and recovery.

Run text streams handle SSE, cursors and duplicate suppression internally, excluding tool payloads and status events. Both convenience helpers report unsuccessful execution or persistence as a typed run error carrying the run ID. A wait timeout stops local waiting without cancelling execution. The language guides describe timeout options, callbacks/iterators, and advanced replay.

Tasks

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`createDecisionTask`	`tasks.createDecision`	`tasks.create_decision`	`Tasks.CreateDecision`
`getDecisionTask`	`tasks.getDecision`	`tasks.get_decision`	`Tasks.GetDecision`
`wakeDecisionTask`	`tasks.wakeDecision`	`tasks.wake_decision`	`Tasks.WakeDecision`
`closeDecisionTask`	`tasks.closeDecision`	`tasks.close_decision`	`Tasks.CloseDecision`
`recordTaskOutcome`	`tasks.recordOutcome`	`tasks.record_outcome`	`Tasks.RecordOutcome`

WebhookDeliveries

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`replayWebhookDelivery`	`webhookDeliveries.replay`	`webhook_deliveries.replay`	`WebhookDeliveries.Replay`
`listWebhookDeliveries`	`webhookDeliveries.list`	`webhook_deliveries.list`	`WebhookDeliveries.List`

Runs

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`streamRun`	`runs.events`	`runs.events`	`Runs.Events`
`getRun`	`runs.get`	`runs.get`	`Runs.Get`
`listArtifacts`	`runs.listArtifacts`	`runs.list_artifacts`	`Runs.ListArtifacts`
`listRunEvents`	`runs.listEvents`	`runs.list_events`	`Runs.ListEvents`
`listRuns`	`runs.list`	`runs.list`	`Runs.List`
`createRun`	`runs.create`	`runs.create`	`Runs.Create`
`getRunResult`	`runs.getResult`	`runs.get_result`	`Runs.GetResult`
`cancelRun`	`runs.cancel`	`runs.cancel`	`Runs.Cancel`
`submitRunInput`	`runs.submitInput`	`runs.submit_input`	`Runs.SubmitInput`

Organizations

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`createOrganization`	`organizations.create`	`organizations.create`	`Organizations.Create`
`revokeInvitation`	`organizations.revokeInvitation`	`organizations.revoke_invitation`	`Organizations.RevokeInvitation`
`getExecutionPolicy`	`organizations.getExecutionPolicy`	`organizations.get_execution_policy`	`Organizations.GetExecutionPolicy`
`updateExecutionPolicy`	`organizations.updateExecutionPolicy`	`organizations.update_execution_policy`	`Organizations.UpdateExecutionPolicy`
`listInvitations`	`organizations.listInvitations`	`organizations.list_invitations`	`Organizations.ListInvitations`
`createInvitation`	`organizations.createInvitation`	`organizations.create_invitation`	`Organizations.CreateInvitation`
`listOrganizationAudit`	`organizations.listAudit`	`organizations.list_audit`	`Organizations.ListAudit`
`updateOrganization`	`organizations.update`	`organizations.update`	`Organizations.Update`
`listMembers`	`organizations.listMembers`	`organizations.list_members`	`Organizations.ListMembers`
`updateMember`	`organizations.updateMember`	`organizations.update_member`	`Organizations.UpdateMember`
`removeMember`	`organizations.removeMember`	`organizations.remove_member`	`Organizations.RemoveMember`

Checkpoints

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`exportCheckpoint`	`checkpoints.exportArchive`	`checkpoints.export_archive`	`Checkpoints.ExportArchive`
`updateCheckpointRetention`	`checkpoints.updateRetention`	`checkpoints.update_retention`	`Checkpoints.UpdateRetention`

Connections

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`listStdioPackages`	`connections.listStdioPackages`	`connections.list_stdio_packages`	`Connections.ListStdioPackages`
`getConnectionAccess`	`connections.getAccess`	`connections.get_access`	`Connections.GetAccess`
`updateConnectionAccess`	`connections.updateAccess`	`connections.update_access`	`Connections.UpdateAccess`
`resolveConnectionAccess`	`connections.resolveAccess`	`connections.resolve_access`	`Connections.ResolveAccess`
`testConnection`	`connections.test`	`connections.test`	`Connections.Test`
`getConnection`	`connections.get`	`connections.get`	`Connections.Get`
`updateConnection`	`connections.update`	`connections.update`	`Connections.Update`
`deleteConnection`	`connections.delete`	`connections.delete`	`Connections.Delete`
`listConnectionTools`	`connections.listTools`	`connections.list_tools`	`Connections.ListTools`
`listConnectionAccessRules`	`connections.listAccessRules`	`connections.list_access_rules`	`Connections.ListAccessRules`
`createConnectionAccessRule`	`connections.createAccessRule`	`connections.create_access_rule`	`Connections.CreateAccessRule`
`updateConnectionAccessRule`	`connections.updateAccessRule`	`connections.update_access_rule`	`Connections.UpdateAccessRule`
`deleteConnectionAccessRule`	`connections.deleteAccessRule`	`connections.delete_access_rule`	`Connections.DeleteAccessRule`
`listConnections`	`connections.list`	`connections.list`	`Connections.List`
`createConnection`	`connections.create`	`connections.create`	`Connections.Create`
`listConnectorCatalog`	`connections.listConnectorCatalog`	`connections.list_connector_catalog`	`Connections.ListConnectorCatalog`
`authorizeConnection`	`connections.authorize`	`connections.authorize`	`Connections.Authorize`

Triggers

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`retryTriggerReply`	`triggers.retryReply`	`triggers.retry_reply`	`Triggers.RetryReply`
`listTriggers`	`triggers.list`	`triggers.list`	`Triggers.List`
`createTrigger`	`triggers.create`	`triggers.create`	`Triggers.Create`
`runTrigger`	`triggers.run`	`triggers.run`	`Triggers.Run`
`getTrigger`	`triggers.get`	`triggers.get`	`Triggers.Get`
`updateTrigger`	`triggers.update`	`triggers.update`	`Triggers.Update`
`deleteTrigger`	`triggers.delete`	`triggers.delete`	`Triggers.Delete`
`listTriggerDeliveries`	`triggers.listDeliveries`	`triggers.list_deliveries`	`Triggers.ListDeliveries`
`rotateTriggerSecret`	`triggers.rotateSecret`	`triggers.rotate_secret`	`Triggers.RotateSecret`

CustomerAgents

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`getCustomerAgentRun`	`customerAgents.getRun`	`customer_agents.get_run`	`CustomerAgents.GetRun`
`updateCustomerAgentConnectionPermissions`	`customerAgents.updateConnectionPermissions`	`customer_agents.update_connection_permissions`	`CustomerAgents.UpdateConnectionPermissions`
`ensureCustomerAgent`	`customerAgents.ensure`	`customer_agents.ensure`	`CustomerAgents.Ensure`
`listCustomerAgents`	`customerAgents.list`	`customer_agents.list`	`CustomerAgents.List`
`listCustomerAgentRunEvents`	`customerAgents.listRunEvents`	`customer_agents.list_run_events`	`CustomerAgents.ListRunEvents`
`sendCustomerAgentMessage`	`customerAgents.sendMessage`	`customer_agents.send_message`	`CustomerAgents.SendMessage`
`getCustomerAgent`	`customerAgents.get`	`customer_agents.get`	`CustomerAgents.Get`
`completeCustomerAgentConnection`	`customerAgents.completeConnection`	`customer_agents.complete_connection`	`CustomerAgents.CompleteConnection`
`listCustomerAgentConnections`	`customerAgents.listConnections`	`customer_agents.list_connections`	`CustomerAgents.ListConnections`
`createCustomerAgentConnection`	`customerAgents.createConnection`	`customer_agents.create_connection`	`CustomerAgents.CreateConnection`
`authorizeCustomerAgentConnection`	`customerAgents.authorizeConnection`	`customer_agents.authorize_connection`	`CustomerAgents.AuthorizeConnection`
`getCustomerAgentRunResult`	`customerAgents.getRunResult`	`customer_agents.get_run_result`	`CustomerAgents.GetRunResult`
`cancelCustomerAgentRun`	`customerAgents.cancelRun`	`customer_agents.cancel_run`	`CustomerAgents.CancelRun`
`deleteCustomerAgentConnection`	`customerAgents.deleteConnection`	`customer_agents.delete_connection`	`CustomerAgents.DeleteConnection`
`listCustomerAgentConversations`	`customerAgents.listConversations`	`customer_agents.list_conversations`	`CustomerAgents.ListConversations`
`streamCustomerAgentRun`	`customerAgents.streamRun`	`customer_agents.stream_run`	`CustomerAgents.StreamRun`
`listCustomerAgentFiles`	`customerAgents.listFiles`	`customer_agents.list_files`	`CustomerAgents.ListFiles`
`readCustomerAgentFile`	`customerAgents.readFile`	`customer_agents.read_file`	`CustomerAgents.ReadFile`

Worktrees

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`restoreWorktree`	`worktrees.restore`	`worktrees.restore`	`Worktrees.Restore`
`createTransfer`	`worktrees.createTransfer`	`worktrees.create_transfer`	`Worktrees.CreateTransfer`
`listTransfers`	`worktrees.listTransfers`	`worktrees.list_transfers`	`Worktrees.ListTransfers`
`createFolder`	`worktrees.createFolder`	`worktrees.create_folder`	`Worktrees.CreateFolder`
`getWorktree`	`worktrees.get`	`worktrees.get`	`Worktrees.Get`
`deleteWorktree`	`worktrees.delete`	`worktrees.delete`	`Worktrees.Delete`
`updateWorktree`	`worktrees.update`	`worktrees.update`	`Worktrees.Update`
`listCheckpoints`	`worktrees.listCheckpoints`	`worktrees.list_checkpoints`	`Worktrees.ListCheckpoints`
`createCheckpoint`	`worktrees.createCheckpoint`	`worktrees.create_checkpoint`	`Worktrees.CreateCheckpoint`
`duplicateFile`	`worktrees.duplicateFile`	`worktrees.duplicate_file`	`Worktrees.DuplicateFile`
`readFile`	`worktrees.readFile`	`worktrees.read_file`	`Worktrees.ReadFile`
`writeFile`	`worktrees.writeFile`	`worktrees.write_file`	`Worktrees.WriteFile`
`deleteFile`	`worktrees.deleteFile`	`worktrees.delete_file`	`Worktrees.DeleteFile`
`renameFile`	`worktrees.renameFile`	`worktrees.rename_file`	`Worktrees.RenameFile`
`listFiles`	`worktrees.listFiles`	`worktrees.list_files`	`Worktrees.ListFiles`
`getWorktreeDiff`	`worktrees.getDiff`	`worktrees.get_diff`	`Worktrees.GetDiff`
`getSync`	`worktrees.getSync`	`worktrees.get_sync`	`Worktrees.GetSync`
`syncWorktree`	`worktrees.sync`	`worktrees.sync`	`Worktrees.Sync`

SlackConnections

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`deleteSlackConnection`	`slackConnections.delete`	`slack_connections.delete`	`SlackConnections.Delete`
`listSlackConnectionChannels`	`slackConnections.listChannels`	`slack_connections.list_channels`	`SlackConnections.ListChannels`
`listSlackConnections`	`slackConnections.list`	`slack_connections.list`	`SlackConnections.List`
`createSlackConnection`	`slackConnections.create`	`slack_connections.create`	`SlackConnections.Create`

Workspaces

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`getWorktreeOptions`	`workspaces.getWorktreeOptions`	`workspaces.get_worktree_options`	`Workspaces.GetWorktreeOptions`
`scheduleWorkspaceDeletion`	`workspaces.scheduleDeletion`	`workspaces.schedule_deletion`	`Workspaces.ScheduleDeletion`
`cancelWorkspaceDeletion`	`workspaces.cancelDeletion`	`workspaces.cancel_deletion`	`Workspaces.CancelDeletion`
`listWorktrees`	`workspaces.listWorktrees`	`workspaces.list_worktrees`	`Workspaces.ListWorktrees`
`createWorktree`	`workspaces.createWorktree`	`workspaces.create_worktree`	`Workspaces.CreateWorktree`
`getWorkspace`	`workspaces.get`	`workspaces.get`	`Workspaces.Get`
`updateWorkspace`	`workspaces.update`	`workspaces.update`	`Workspaces.Update`
`deleteWorkspace`	`workspaces.delete`	`workspaces.delete`	`Workspaces.Delete`
`listWorkspaces`	`workspaces.list`	`workspaces.list`	`Workspaces.List`
`createWorkspace`	`workspaces.create`	`workspaces.create`	`Workspaces.Create`

Workers

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`getWorker`	`workers.get`	`workers.get`	`Workers.Get`
`patchWorker`	`workers.patch`	`workers.patch`	`Workers.Patch`
`destroyWorker`	`workers.destroy`	`workers.destroy`	`Workers.Destroy`
`resumeWorker`	`workers.resume`	`workers.resume`	`Workers.Resume`
`listWorkerOfferings`	`workers.listOfferings`	`workers.list_offerings`	`Workers.ListOfferings`
`pauseWorker`	`workers.pause`	`workers.pause`	`Workers.Pause`
`listWorkers`	`workers.list`	`workers.list`	`Workers.List`
`createWorker`	`workers.create`	`workers.create`	`Workers.Create`

Operator

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`getCapacityReport`	`operator.getCapacityReport`	`operator.get_capacity_report`	`Operator.GetCapacityReport`
`getPlatformUsageMetrics`	`operator.getPlatformUsageMetrics`	`operator.get_platform_usage_metrics`	`Operator.GetPlatformUsageMetrics`
`getAccountSummary`	`operator.getAccountSummary`	`operator.get_account_summary`	`Operator.GetAccountSummary`
`getRunDiagnostics`	`operator.getRunDiagnostics`	`operator.get_run_diagnostics`	`Operator.GetRunDiagnostics`
`getInfrastructureHealth`	`operator.getInfrastructureHealth`	`operator.get_infrastructure_health`	`Operator.GetInfrastructureHealth`
`listReportSnapshots`	`operator.listReportSnapshots`	`operator.list_report_snapshots`	`Operator.ListReportSnapshots`
`listAccounts`	`operator.listAccounts`	`operator.list_accounts`	`Operator.ListAccounts`
`getOperatingReport`	`operator.getOperatingReport`	`operator.get_operating_report`	`Operator.GetOperatingReport`
`getGrowthMetrics`	`operator.getGrowthMetrics`	`operator.get_growth_metrics`	`Operator.GetGrowthMetrics`
`listPlatformRequests`	`operator.listPlatformRequests`	`operator.list_platform_requests`	`Operator.ListPlatformRequests`

Integrations

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`listGithubRepositories`	`integrations.listGithubRepositories`	`integrations.list_github_repositories`	`Integrations.ListGithubRepositories`
`listGithubInstallations`	`integrations.listGithubInstallations`	`integrations.list_github_installations`	`Integrations.ListGithubInstallations`
`disconnectGithub`	`integrations.disconnectGithub`	`integrations.disconnect_github`	`Integrations.DisconnectGithub`

Billing

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`getBilling`	`billing.get`	`billing.get`	`Billing.Get`
`getStorage`	`billing.getStorage`	`billing.get_storage`	`Billing.GetStorage`
`updateStoragePolicy`	`billing.updateStoragePolicy`	`billing.update_storage_policy`	`Billing.UpdateStoragePolicy`
`createBillingPortal`	`billing.createPortal`	`billing.create_portal`	`Billing.CreatePortal`
`listBillingUsage`	`billing.listUsage`	`billing.list_usage`	`Billing.ListUsage`
`createCheckout`	`billing.createCheckout`	`billing.create_checkout`	`Billing.CreateCheckout`

ApiKeys

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`revokeApiKey`	`apiKeys.revoke`	`api_keys.revoke`	`ApiKeys.Revoke`
`listApiKeys`	`apiKeys.list`	`api_keys.list`	`ApiKeys.List`
`createApiKey`	`apiKeys.create`	`api_keys.create`	`ApiKeys.Create`

Sessions

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`continueSession`	`sessions.continueRun`	`sessions.continue_run`	`Sessions.ContinueRun`
`listSessions`	`sessions.list`	`sessions.list`	`Sessions.List`
`createSession`	`sessions.create`	`sessions.create`	`Sessions.Create`
`getSession`	`sessions.get`	`sessions.get`	`Sessions.Get`

Inferences

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`getContextArtifact`	`inferences.getContextArtifact`	`inferences.get_context_artifact`	`Inferences.GetContextArtifact`
`deleteContextArtifact`	`inferences.deleteContextArtifact`	`inferences.delete_context_artifact`	`Inferences.DeleteContextArtifact`
`getDecisionDefinition`	`inferences.getDecisionDefinition`	`inferences.get_decision_definition`	`Inferences.GetDecisionDefinition`
`deleteDecisionDefinition`	`inferences.deleteDecisionDefinition`	`inferences.delete_decision_definition`	`Inferences.DeleteDecisionDefinition`
`createInference`	`inferences.create`	`inferences.create`	`Inferences.Create`
`createBoundedAgentRun`	`inferences.createBoundedAgentRun`	`inferences.create_bounded_agent_run`	`Inferences.CreateBoundedAgentRun`
`createDecisionDefinition`	`inferences.createDecisionDefinition`	`inferences.create_decision_definition`	`Inferences.CreateDecisionDefinition`
`createContextArtifact`	`inferences.createContextArtifact`	`inferences.create_context_artifact`	`Inferences.CreateContextArtifact`

WebhookEndpoints

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`listWebhookEndpoints`	`webhookEndpoints.list`	`webhook_endpoints.list`	`WebhookEndpoints.List`
`createWebhookEndpoint`	`webhookEndpoints.create`	`webhook_endpoints.create`	`WebhookEndpoints.Create`
`updateWebhookEndpoint`	`webhookEndpoints.update`	`webhook_endpoints.update`	`WebhookEndpoints.Update`
`deleteWebhookEndpoint`	`webhookEndpoints.delete`	`webhook_endpoints.delete`	`WebhookEndpoints.Delete`
`rotateWebhookSecret`	`webhookEndpoints.rotateWebhookSecret`	`webhook_endpoints.rotate_webhook_secret`	`WebhookEndpoints.RotateWebhookSecret`

Artifacts

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`deleteArtifact`	`artifacts.delete`	`artifacts.delete`	`Artifacts.Delete`
`downloadArtifact`	`artifacts.download`	`artifacts.download`	`Artifacts.Download`

Transfers

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`applyTransfer`	`transfers.apply`	`transfers.apply`	`Transfers.Apply`
`getTransfer`	`transfers.get`	`transfers.get`	`Transfers.Get`

Usage

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`getUsage`	`usage.get`	`usage.get`	`Usage.Get`

Operations

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`getOperation`	`operations.get`	`operations.get`	`Operations.Get`

Models

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`listModels`	`models.list`	`models.list`	`Models.List`

Agents

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`listAgents`	`agents.list`	`agents.list`	`Agents.List`
`createAgent`	`agents.create`	`agents.create`	`Agents.Create`
`getAgent`	`agents.get`	`agents.get`	`Agents.Get`
`updateAgent`	`agents.update`	`agents.update`	`Agents.Update`
`deleteAgent`	`agents.delete`	`agents.delete`	`Agents.Delete`

Me

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`getIdentity`	`me.get`	`me.get`	`Me.Get`

Requests

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`listRequests`	`requests.list`	`requests.list`	`Requests.List`

Harnesses

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`listHarnesses`	`harnesses.list`	`harnesses.list`	`Harnesses.List`

ModelDeployments

OpenAPI operation	TypeScript / Java	Python / Rust	Go
`inspectModelDeployment`	`modelDeployments.inspect`	`model_deployments.inspect`	`ModelDeployments.Inspect`
`createModelDeployment`	`modelDeployments.create`	`model_deployments.create`	`ModelDeployments.Create`
`listModelDeployments`	`modelDeployments.list`	`model_deployments.list`	`ModelDeployments.List`
`getModelDeployment`	`modelDeployments.get`	`model_deployments.get`	`ModelDeployments.Get`
`deleteModelDeployment`	`modelDeployments.delete`	`model_deployments.delete`	`ModelDeployments.Delete`
`createModelDeploymentRevision`	`modelDeployments.createRevision`	`model_deployments.create_revision`	`ModelDeployments.CreateRevision`
`listModelDeploymentRevisions`	`modelDeployments.listRevisions`	`model_deployments.list_revisions`	`ModelDeployments.ListRevisions`
`getModelDeploymentRevision`	`modelDeployments.getRevision`	`model_deployments.get_revision`	`ModelDeployments.GetRevision`
`listModelDeploymentGrants`	`modelDeployments.listGrants`	`model_deployments.list_grants`	`ModelDeployments.ListGrants`
`createModelDeploymentGrant`	`modelDeployments.createGrant`	`model_deployments.create_grant`	`ModelDeployments.CreateGrant`
`revokeModelDeploymentGrant`	`modelDeployments.revokeGrant`	`model_deployments.revoke_grant`	`ModelDeployments.RevokeGrant`
`setModelDeploymentService`	`modelDeployments.setService`	`model_deployments.set_service`	`ModelDeployments.SetService`