Skip to main content

​
AraClient

Runtime client bound to one App manifest. Class source

​
Methods

​
client.from_env

View source 
from_env(cls) -> 'AraClient'
When to use: Build a client from environment variables. Primary auth is ARA_API_KEY; legacy ARA_ACCESS_TOKEN is accepted as fallback.

​
client.deploy

View source 
deploy(self) -> dict[str, Any]
When to use: Create or update app config, sync local secrets, mint runtime key, and optionally warm an agent via warm_agent_id.

​
client.run

View source 
run(self)
When to use: Invoke an agent turn synchronously. SDK sends both agent_id and compatibility workflow_id.

​
client.events

View source 
events(self) -> dict[str, Any]
When to use: Send event payloads into app automation/runtime flow with runtime authentication.

​
client.setup

View source 
setup(self) -> dict[str, Any]
When to use: Fetch app setup metadata (including runtime inheritance and auth hints).

​
client.setup_auth

View source 
setup_auth(self) -> dict[str, Any]
When to use: Create or reuse app header key auth and write .app-header-key.local for subsequent run/events calls.

​
client.run_async

View source 
run_async(self) -> dict[str, Any]
When to use: Submit async runs and choose response_mode (poll or webhook) with optional callback configuration.

​
client.run_status

View source 
run_status(self) -> dict[str, Any]
When to use: Poll async run completion/status by run_id.

​
client.invite

View source 
invite(self) -> dict[str, Any]
When to use: Create app invites with role and expiry controls.