Skip to main content

Decision Layer SDK for AI agents. Encrypted actionable decisions over gRPC.

Project description

📦 @noxy-network/python-sdk

SDK for AI agent backends integrating with Noxy human-in-the-loop guardrails: send encrypted, actionable prompts (tool proposals, approvals, next-step hints) to registered user devices over gRPC so users can take decisions before work proceeds.

Before you integrate: Create your app at noxy.network. When the app is created, you receive an app id and an app token (auth token). This Python SDK authenticates with the relay using the app token (auth_token in NoxyConfig). The app id is used by client SDKs (browser, iOS, Android, Telegram bot), not as the bearer token here.

Overview

  • Route decisions to devices bound to a logical identity: wallet (0x…), email, phone, app user_id, …—whatever matches identity_id / device linking in your Noxy app.
  • Receive delivery outcomes from the relay plus a decision_id when the relay accepts the route.
  • Wait for human-in-the-loop resolutionusers take decisions on-device and outcomes return via polling; prompts can expire. The usual path is send_decision_and_wait_for_outcome.
  • Query quota and resolve identity devices.

The wire API uses agent.proto (noxy.agent.AgentService): RouteDecision, GetDecisionOutcome, GetQuota, GetIdentityDevices.

Communication is gRPC over TLS with Bearer authentication. Payloads are encrypted end-to-end (Kyber + AES-256-GCM) per device before leaving your process.

Requirements

  • Python >= 3.10

Installation

pip install noxy-sdk

Quick start

from noxy import (
    NoxyHumanDecisionOutcome,
    init_noxy_agent_client,
    NoxyConfig,
)

client = init_noxy_agent_client(
    NoxyConfig(
        endpoint="https://relay.noxy.network",
        auth_token="your-api-token",
        decision_ttl_seconds=3600,
    )
)

resolution = client.send_decision_and_wait_for_outcome(
    "user@example.com",  # or 0x…, phone, user_id — match device registration
    {
        "kind": "propose_tool_call",
        "tool": "transfer_funds",
        "args": { "to": "0x000000000000000000000000000000000000dEaD", "amountWei": "1" },
        "title": "Transfer 1 wei to the burn address",
        "summary": "The agent is requesting approval to send 1 wei to the burn address.",
    },
)

if resolution.outcome == NoxyHumanDecisionOutcome.APPROVED:
    ...

Configuration

Option Type Required Description
endpoint str Yes Relay gRPC endpoint. https:// is stripped; TLS is used.
auth_token str Yes Bearer token for relay auth.
decision_ttl_seconds int Yes TTL for routed decisions (seconds).

SendDecisionAndWaitOptions

Optional argument to send_decision_and_wait_for_outcome.

Field Type Default Description
initial_poll_interval_ms float | None 400 First delay between polls (ms).
max_poll_interval_ms float | None 30000 Cap between polls (ms).
max_wait_ms float | None 900000 Total budget (ms). Raises WaitForDecisionOutcomeTimeoutError.
backoff_multiplier float | None 1.6 Backoff multiplier per iteration.

API

  • init_noxy_agent_client(config) -> NoxyAgentClient
  • NoxyIdentityId — type alias for relay identity_id (str).
  • NoxyAgentClient: send_decision(identity_id, ...), get_decision_outcome, wait_for_decision_outcome, send_decision_and_wait_for_outcome, get_quota, close
  • is_terminal_human_outcome, poll_decision_outcome_loop (advanced)
  • Exceptions: WaitForDecisionOutcomeTimeoutError, SendDecisionAndWaitNoDecisionIdError

Regenerating gRPC code

From the package root (requires grpcio-tools):

python -m grpc_tools.protoc -I proto --python_out=noxy/grpc --grpc_python_out=noxy/grpc proto/agent.proto

Then fix the import in noxy/grpc/agent_pb2_grpc.py to use a relative import:

from . import agent_pb2 as agent__pb2

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

noxy_sdk-2.2.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

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

noxy_sdk-2.2.0-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file noxy_sdk-2.2.0.tar.gz.

File metadata

  • Download URL: noxy_sdk-2.2.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for noxy_sdk-2.2.0.tar.gz
Algorithm Hash digest
SHA256 40264475ee42855a047832783e5ed7bf40f34216aa3c51ddca9f8d6381aa90b2
MD5 7fe1515f491e9c56cc4b3e3f94c9cdc1
BLAKE2b-256 b200111ad62e858776244201d2731ba96b89375bf36045a041ef77b3fde0d8ed

See more details on using hashes here.

File details

Details for the file noxy_sdk-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: noxy_sdk-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for noxy_sdk-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de90242122a4052f7ade80e1f90f70d6e710efc6983917ed90a84c5a73d0d366
MD5 2e5f53f8dea0d8a023da785a6267c966
BLAKE2b-256 745536c1b0f4e7c9028228ed723c6652762c3212d843b3b2b1b91b533a625adb

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