Struct AgentKernel 

pub struct AgentKernel { /* private fields */ }

Client for the agentkernel HTTP API.

Example

let client = agentkernel_sdk::AgentKernel::builder().build()?;
let output = client.run(&["echo", "hello"], None).await?;
println!("{}", output.output);

Implementations

impl AgentKernel

pub fn builder() -> AgentKernelBuilder

Create a new builder with defaults resolved from env vars.

pub async fn health(&self) -> Result<String>

Health check. Returns "ok".

pub async fn run( &self, command: &[&str], opts: Option<RunOptions>, ) -> Result<RunOutput>

Run a command in a temporary sandbox.

pub async fn list_sandboxes(&self) -> Result<Vec<SandboxInfo>>

List all sandboxes.

pub async fn create_sandbox( &self, name: &str, opts: Option<CreateSandboxOptions>, ) -> Result<SandboxInfo>

Create a new sandbox with optional configuration.

pub async fn get_sandbox(&self, name: &str) -> Result<SandboxInfo>

Get info about a sandbox.

pub async fn get_sandbox_by_uuid(&self, uuid: &str) -> Result<SandboxInfo>

Get info about a sandbox by UUID.

pub async fn remove_sandbox(&self, name: &str) -> Result<()>

Remove a sandbox.

pub async fn exec_in_sandbox( &self, name: &str, command: &[&str], opts: Option<ExecOptions>, ) -> Result<RunOutput>

Run a command in an existing sandbox.

pub async fn with_sandbox<F, Fut, T>( &self, name: &str, opts: Option<CreateSandboxOptions>, f: F, ) -> Result<T>

where F: FnOnce(SandboxHandle) -> Fut, Fut: Future<Output = Result<T>>,

Create a sandbox and return a guard that removes it on drop.

Use with_sandbox for guaranteed cleanup via a closure.

pub async fn browser( &self, name: &str, memory_mb: Option<u64>, ) -> Result<BrowserSession>

Create a browser sandbox with Playwright/Chromium pre-installed.

Returns a BrowserSession you can use to navigate pages, take screenshots, and evaluate JavaScript expressions.

Example

let client = agentkernel_sdk::AgentKernel::builder().build()?;
let mut browser = client.browser("my-browser", None).await?;
let page = browser.goto("https://example.com").await?;
println!("{}", page.title);
browser.remove().await?;

pub async fn write_files( &self, name: &str, files: HashMap<String, String>, ) -> Result<BatchFileWriteResponse>

Write multiple files to a sandbox in one request.

pub async fn read_file( &self, name: &str, path: &str, ) -> Result<FileReadResponse>

Read a file from a sandbox.

pub async fn write_file( &self, name: &str, path: &str, content: &str, encoding: Option<&str>, ) -> Result<String>

Write a file to a sandbox.

pub async fn delete_file(&self, name: &str, path: &str) -> Result<String>

Delete a file from a sandbox.

pub async fn get_sandbox_logs(&self, name: &str) -> Result<Vec<Value>>

Get audit log entries for a sandbox.

pub async fn exec_detached( &self, name: &str, command: &[&str], opts: Option<ExecOptions>, ) -> Result<DetachedCommand>

Start a detached (background) command in a sandbox.

pub async fn detached_status( &self, name: &str, cmd_id: &str, ) -> Result<DetachedCommand>

Get the status of a detached command.

pub async fn detached_logs( &self, name: &str, cmd_id: &str, stream: Option<&str>, ) -> Result<DetachedLogsResponse>

Get logs from a detached command.

pub async fn detached_kill(&self, name: &str, cmd_id: &str) -> Result<String>

Kill a detached command.

pub async fn detached_list(&self, name: &str) -> Result<Vec<DetachedCommand>>

List detached commands in a sandbox.

pub async fn batch_run( &self, commands: Vec<BatchCommand>, ) -> Result<BatchRunResponse>

Run multiple commands in parallel.

pub async fn list_orchestrations(&self) -> Result<Vec<Orchestration>>

List all orchestrations.

pub async fn create_orchestration( &self, payload: OrchestrationCreateRequest, ) -> Result<Orchestration>

Create a new orchestration.

pub async fn get_orchestration(&self, id: &str) -> Result<Orchestration>

Get a single orchestration by id.

pub async fn signal_orchestration( &self, id: &str, payload: Value, ) -> Result<Orchestration>

Raise an external event for an orchestration.

pub async fn terminate_orchestration( &self, id: &str, payload: Option<Value>, ) -> Result<Orchestration>

Terminate an orchestration.

pub async fn list_orchestration_definitions( &self, ) -> Result<Vec<OrchestrationDefinition>>

List orchestration definitions.

pub async fn upsert_orchestration_definition( &self, payload: OrchestrationDefinition, ) -> Result<OrchestrationDefinition>

Register or update an orchestration definition.

pub async fn get_orchestration_definition( &self, name: &str, ) -> Result<OrchestrationDefinition>

Get an orchestration definition by name.

pub async fn delete_orchestration_definition( &self, name: &str, ) -> Result<String>

Delete an orchestration definition by name.

pub async fn list_objects(&self) -> Result<Vec<DurableObject>>

List all objects.

pub async fn create_object( &self, payload: DurableObjectCreateRequest, ) -> Result<DurableObject>

Create a new object.

pub async fn get_object(&self, id: &str) -> Result<DurableObject>

Get a single object by id.

pub async fn call_object( &self, class: &str, object_id: &str, method: &str, args: Value, ) -> Result<Value>

Call a method on a durable object (auto-creates/wakes if needed).

pub async fn delete_object(&self, id: &str) -> Result<String>

Delete a durable object by id.

pub async fn patch_object( &self, id: &str, payload: Value, ) -> Result<DurableObject>

Partially update a durable object (storage and/or status).

pub async fn list_schedules(&self) -> Result<Vec<Schedule>>

List all schedules.

pub async fn create_schedule( &self, payload: ScheduleCreateRequest, ) -> Result<Schedule>

Create a new schedule.

pub async fn get_schedule(&self, id: &str) -> Result<Schedule>

Get a single schedule by id.

pub async fn delete_schedule(&self, id: &str) -> Result<String>

Delete a schedule by id.

pub async fn list_stores(&self) -> Result<Vec<DurableStore>>

List all durable stores.

pub async fn create_store( &self, payload: DurableStoreCreateRequest, ) -> Result<DurableStore>

Create a new durable store.

pub async fn get_store(&self, id: &str) -> Result<DurableStore>

Get a durable store by id.

pub async fn delete_store(&self, id: &str) -> Result<String>

Delete a durable store by id.

pub async fn query_store( &self, id: &str, payload: Value, ) -> Result<DurableStoreQueryResult>

Run a read query against a durable store.

pub async fn execute_store( &self, id: &str, payload: Value, ) -> Result<DurableStoreExecuteResult>

Run a write statement against a durable store.

pub async fn command_store( &self, id: &str, payload: Value, ) -> Result<DurableStoreCommandResult>

Run a command against a durable store (Redis-style engines).

pub async fn extend_ttl( &self, name: &str, by: &str, ) -> Result<ExtendTtlResponse>

Extend a sandbox’s time-to-live.

pub async fn list_snapshots(&self) -> Result<Vec<SnapshotMeta>>

List all snapshots.

pub async fn take_snapshot( &self, opts: TakeSnapshotOptions, ) -> Result<SnapshotMeta>

Take a snapshot of a sandbox.

pub async fn get_snapshot(&self, name: &str) -> Result<SnapshotMeta>

Get info about a snapshot.

pub async fn delete_snapshot(&self, name: &str) -> Result<()>

Delete a snapshot.

pub async fn restore_snapshot(&self, name: &str) -> Result<SandboxInfo>

Restore a sandbox from a snapshot.

Trait Implementations

impl Clone for AgentKernel

fn clone(&self) -> AgentKernel

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.