Skip to main content

Public Python SDK for building and running Ara apps.

Project description

Ara Python SDK

Ara is a managed platform for building and running long-lived AI agents in the cloud.

The ara-sdk is the Python layer for defining those agents, tools, schedules, and endpoints as code. Ara runs the cloud runtime and operations, while the SDK gives you composable primitives to build novel 24/7 managed workflows.

Overview

Main SDK primitives:

  • App(...): define one deployable Ara app.
  • @app.agent(...): define agent behavior and entrypoints.
  • @app.tool(...): expose deterministic functions as callable tools.
  • @app.schedule(...): trigger agents/tools on cron or fixed times.
  • @fastapi_endpoint(...): expose HTTP endpoints backed by app agents.
  • runtime(...) + Secret: declare runtime env, startup, model selection, and secrets.

These primitives can be combined to run always-on assistants, scheduled automation jobs, and API-triggered workflows in one app.

Runtime flow:

Users / Clients
  (Web app, SMS, Slack, Email)
            |
            |  HTTP (bidirectional webhooks / responses)
            v
+----------------------------------------------+
|         Ara Cloud: 24/7 Agent Runtime        |
|  - Interprets prompt + workflow              |
|  - Activates sandbox when work is needed     |
+--------------------------+-------------------+
                           |
                           v
                 +------------------------+
                 |   Sandbox / Computer   |
                 | - File system access   |
                 | - Executes tasks/tools |
                 +-----------+------------+
                             |
            +----------------+----------------+
            v                                 v
 +---------------------------+   +---------------------------+
 | Custom tools / skill files|   | Subagents / other agents |
 +---------------------------+   +---------------------------+

Quickstart:

from ara_sdk import App, fastapi_endpoint

app = App("support-ops")

@app.tool()
def send_email(to: str, subject: str, body: str) -> dict:
    return {"ok": True, "to": to, "subject": subject}

@app.schedule(cron="0 * * * *")
@app.agent(entrypoint=True, skills=["send_email"])
def support_coordinator(input: dict) -> str:
    _ = input if isinstance(input, dict) else {}
    return "Handle support operations and send follow-ups."

@app.agent()
@fastapi_endpoint(method="POST", path="/webhooks/inbound", auth="none")
def inbound_webhook(input: dict) -> str:
    _ = input if isinstance(input, dict) else {}
    return "Process inbound webhook events."

Install

pip install ara-sdk

Documentation

Runtime Automation CLI

The CLI supports first-class user automation management:

ara automation list
ara automation add --name "daily-check" --cron "0 9 * * *" --message "Daily summary"
ara automation disable --id <job_id>
ara automation remove --id <job_id> --yes
ara automation purge --all --yes
ara automation runs --state failed
ara automation replay --run-id <run_id>

Local testing (no uv)

python3.12 -m venv .venv
source .venv/bin/activate
python -m pip install -e . pytest
python -m pytest -q

Run maintained examples

Examples: github.com/Aradotso/ara-python-sdk/tree/main/examples

FAQ

What is the difference between Ara and ara-sdk?

Ara is the managed control/runtime plane (execution, lifecycle, policy, observability), while ara-sdk is the authoring layer for app behavior (agents, tools, schedules, endpoints). You define Python app logic; Ara handles runtime operations you would otherwise run as custom infrastructure.

Does “24/7 runtime” mean I pay for permanently hot compute?

Not inherently. The runtime is always available as the service boundary, but sandbox/task compute can activate on demand from schedules, events, and API calls. Practical cost and footprint depend on your trigger frequency and runtime policy. Note: today usage is billed under your existing Pro or Ultra subscription.

How should I think about @app.agent, @app.tool, and @app.schedule (and when to use each)?

Use @app.agent for interpretation/planning, @app.tool for deterministic and reusable capability execution, and @app.schedule for time-based triggers. Combined, they let you build always-on workflows that handle operational automation, filesystem/computer-style tasks, and multi-agent delegation beyond chat-only use cases.

How do I handle secrets and environment safely at scale?

Use runtime secret primitives (Secret + runtime(...)) so credentials are injected at runtime instead of committed in code. This keeps apps portable across environments and reduces secret exposure in source control.

Do I need public endpoints to use Ara?

No. Public endpoints are optional ingress, not a requirement for running Ara apps. You can operate entirely through CLI-triggered runs, schedules, and internal automation flows, then expose HTTP/webhook entrypoints with @fastapi_endpoint(...) only when external systems (or users) need to call in directly.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ara_sdk-0.1.47.tar.gz (56.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ara_sdk-0.1.47-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file ara_sdk-0.1.47.tar.gz.

File metadata

  • Download URL: ara_sdk-0.1.47.tar.gz
  • Upload date:
  • Size: 56.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ara_sdk-0.1.47.tar.gz
Algorithm Hash digest
SHA256 3d7639d63f01a07f32a3f042744d4f058225eee73ea5b8857d36604a4825bbf8
MD5 20434b997adab2624851ef85d25144e3
BLAKE2b-256 86e243c1f7ddd9aba3626af26f3ff10633932efa9a7ed13d5b0805d6de4869f7

See more details on using hashes here.

File details

Details for the file ara_sdk-0.1.47-py3-none-any.whl.

File metadata

  • Download URL: ara_sdk-0.1.47-py3-none-any.whl
  • Upload date:
  • Size: 41.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ara_sdk-0.1.47-py3-none-any.whl
Algorithm Hash digest
SHA256 e821cd40fe42980cc3e5ba7e47b41acae00953db282aee9f873cd378f276d007
MD5 41cebf7b39fe4abaf6bbcbc4689695a9
BLAKE2b-256 7bb67a3f5d195bc3b541bb6e8b3c5af9d0d0c1074b093bf3ed5022ac0badf3f3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page