Skip to main content

​
Helper Functions

​
Functions

​
ara_sdk.file

View source 
file(path: str, content: str) -> dict[str, Any]
When to use: Attach inline file content to runtime profile files.

​
ara_sdk.local_file

View source 
local_file(source: str | pathlib.Path, path: Optional[str] = None) -> dict[str, Any]
When to use: Read a local file and include it in runtime profile files.

​
ara_sdk.entrypoint

View source 
entrypoint(command: str) -> dict[str, Any]
When to use: Define startup command metadata for runtime boot.

​
ara_sdk.runtime

View source 
runtime() -> dict[str, Any]
When to use: Assemble runtime profile (env, secrets, files/startup/resources).

​
ara_sdk.sandbox

View source 
sandbox() -> dict[str, Any]
When to use: Define sandbox placement/spawn policy for agents.

​
ara_sdk.git_artifact

View source 
git_artifact(repo_url: str) -> dict[str, Any]
When to use: Attach a Git repository artifact reference.

​
ara_sdk.tarball_artifact

View source 
tarball_artifact(url: str) -> dict[str, Any]
When to use: Attach a tarball artifact reference.

​
ara_sdk.command_adapter

View source 
command_adapter(entrypoint: str) -> dict[str, Any]
When to use: Build a command-based framework adapter descriptor.

​
ara_sdk.langgraph_adapter

View source 
langgraph_adapter(entrypoint: str = 'python3 langgraph_worker.py') -> dict[str, Any]
When to use: Build a LangGraph adapter descriptor.

​
ara_sdk.langchain_adapter

View source 
langchain_adapter(entrypoint: str = 'python3 langchain_worker.py') -> dict[str, Any]
When to use: Build a LangChain adapter descriptor.

​
ara_sdk.agno_adapter

View source 
agno_adapter(entrypoint: str = 'python3 agno_worker.py') -> dict[str, Any]
When to use: Build an Agno adapter descriptor.

​
ara_sdk.event_envelope

View source 
event_envelope(event_type: str) -> dict[str, Any]
When to use: Create canonical event envelope payload stubs.

​
ara_sdk.run_cli

View source 
run_cli(app: App | dict[str, Any], argv: Optional[list[str]] = None) -> None
When to use: Dispatch SDK CLI commands for deploy, auth setup, sync run, async run, and events.

​
Namespaced builders

​
invoke.agent

View source 
invoke.agent(agent_id: str, *, input: Optional[dict[str, Any]] = None) -> dict[str, Any]
When to use: Build an agent-target run descriptor used by schedule.cron(...) or schedule.every(...).

​
invoke.tool

View source 
invoke.tool(tool_name: str, *, args: Optional[dict[str, Any]] = None) -> dict[str, Any]
When to use: Build a tool-target run descriptor for schedule-based automation.

​
schedule.cron

View source 
schedule.cron(*, id: str, expr: str, timezone: str = 'UTC', run: dict[str, Any]) -> dict[str, Any]
When to use: Declare cron schedules on @app.agent(..., schedules=[...]) using validated schedule spec shape.

​
schedule.every

View source 
schedule.every(*, id: str, seconds: int, run: dict[str, Any]) -> dict[str, Any]
When to use: Declare fixed-interval schedules (minimum 60 seconds) using the same run target shape.

​
scheduler.create

View source 
scheduler.create(spec: dict[str, Any], *, app_id: Optional[str] = None) -> dict[str, Any]
When to use: Build automation_create payloads from schedule specs for dynamic runtime creation flows.

​
scheduler.upsert

View source 
scheduler.upsert(spec: dict[str, Any], *, app_id: Optional[str] = None) -> dict[str, Any]
When to use: Build idempotent dynamic schedule payloads (upsert=True) from the same schedule spec format.