Skip to main content

SDK for building orchagent agents - enables agent-to-agent calls with local execution support

Project description

orchagent SDK

Official Python SDK for building orchagent agents with agent-to-agent call support.

Installation

pip install orchagent-sdk

Note: The pip package is orchagent-sdk but the Python import is from orchagent import .... This is a common Python convention (e.g. Pillowimport PIL).

Quick Start

# pip install orchagent-sdk  (package name)
from orchagent import AgentClient  # module name

# Create a client (uses ORCHAGENT_SERVICE_KEY env var)
client = AgentClient()

# Call another agent
async def my_orchestrator(input_data):
    result = await client.call("joe/leak-finder@v1", {"url": input_data["repo"]})
    return result

Features

  • Agent-to-agent calls - Call other agents from within your orchestrator agent
  • Service key authentication - Automatic auth via ORCHAGENT_SERVICE_KEY env var
  • Call chain tracking - Prevents circular dependencies (A calls B calls A)
  • Deadline propagation - Timeout context flows through the call chain
  • Local execution mode - Test orchestrators locally with orch run --with-deps

Usage

Basic Usage

from orchagent import AgentClient

client = AgentClient()
result = await client.call("org/agent@v1", {"input": "data"})
# result is the raw agent output — the gateway envelope is auto-unwrapped

With FastAPI

Extract call context from incoming requests:

from fastapi import Request
from orchagent import AgentClient

@app.post("/analyze")
async def analyze(request: Request, input: AnalyzeInput):
    # Automatically extracts call chain, deadline, etc. from request headers
    client = AgentClient.from_request(request)
    secrets = await client.call("joe/leak-finder@v1", {"url": input.repo_url})
    return {"secrets": secrets}

Error Handling

from orchagent import (
    AgentClient,
    DependencyCallError,
    CallChainCycleError,
    TimeoutExceededError,
)

try:
    result = await client.call("org/agent@v1", data)
except CallChainCycleError:
    # Would create a circular dependency
    pass
except TimeoutExceededError:
    # Deadline passed
    pass
except DependencyCallError as e:
    # Agent returned an error
    print(f"Status: {e.status_code}, Body: {e.response_body}")

Local Execution Mode

When running with orch run --with-deps, the SDK automatically detects local mode and spawns sub-agents as local subprocesses instead of making HTTP calls.

# Agents are executed locally as subprocesses
orch run orchagent/security-review --with-deps --input '{"path": "."}'

This is controlled by the ORCHAGENT_LOCAL_EXECUTION=true environment variable, which the CLI sets automatically.

Environment Variables

Variable Description
ORCHAGENT_SERVICE_KEY Service key for API authentication. Auto-injected by the gateway for agents with manifest dependencies — do not add to required_secrets
ORCHAGENT_GATEWAY_URL Gateway URL (default: https://api.orchagent.io)
ORCHAGENT_LOCAL_EXECUTION Enable local subprocess execution
ORCHAGENT_AGENTS_DIR Path to local agents (default: ~/.orchagent/agents)

API Reference

AgentClient

class AgentClient:
    def __init__(
        self,
        service_key: str | None = None,      # From ORCHAGENT_SERVICE_KEY
        gateway_url: str | None = None,       # From ORCHAGENT_GATEWAY_URL
        call_chain: list[str] | None = None,  # Current call chain
        deadline_ms: int | None = None,       # Deadline timestamp
        max_hops: int | None = None,          # Max remaining hops
    ): ...

    @classmethod
    def from_request(cls, request, service_key=None) -> "AgentClient": ...

    async def call(
        self,
        agent_ref: str,           # "org/agent@version"
        input_data: dict,         # Input payload
        endpoint: str | None,     # Optional endpoint override
        timeout: float | None,    # Optional timeout in seconds
    ) -> Any: ...
    # Returns the raw agent output, not the gateway envelope.
    # The gateway wraps responses in {"data": ..., "metadata": ...} —
    # the SDK auto-unwraps this so you get the agent's output directly.

Exceptions

  • AgentClientError - Base exception
  • DependencyCallError - Agent call failed (has status_code, response_body)
  • CallChainCycleError - Would create circular dependency
  • TimeoutExceededError - Deadline passed
  • LocalExecutionError - Subprocess execution failed (has exit_code, stderr)

License

MIT

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

orchagent_sdk-0.1.12.tar.gz (21.1 kB view details)

Uploaded Source

Built Distribution

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

orchagent_sdk-0.1.12-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file orchagent_sdk-0.1.12.tar.gz.

File metadata

  • Download URL: orchagent_sdk-0.1.12.tar.gz
  • Upload date:
  • Size: 21.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for orchagent_sdk-0.1.12.tar.gz
Algorithm Hash digest
SHA256 0470c55fa683ab23e420d507c6ae8e7e3222bec93694f887faba2b2ed6dc45ce
MD5 cbe15d58f03ebeb0f034f62b5fe232f1
BLAKE2b-256 dae8e8a6b3ea1fdba34a90ec614db4cba01e111638585c8fe19f6e31a85cafa0

See more details on using hashes here.

File details

Details for the file orchagent_sdk-0.1.12-py3-none-any.whl.

File metadata

  • Download URL: orchagent_sdk-0.1.12-py3-none-any.whl
  • Upload date:
  • Size: 16.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for orchagent_sdk-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 10f5e950c0b35b63b4f9deb38c70d5f9fd5fa21e2f397fc8d2b0a637af00a84a
MD5 993119441e8985ec4e503b68bd6656e6
BLAKE2b-256 47e9941afabd905fd73cf276ef73c8b7756fc0eb5ab1d20b62c2765d5e5a4749

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