Skip to main content

ArmorIQ SDK - Build secure AI agents with cryptographic intent verification.

Project description

ArmorIQ SDK

Build secure AI agents with cryptographic intent verification.

The ArmorIQ SDK enables developers to build AI agents with built-in security and auditability. Just one API key - no cloud complexity.


Why ArmorIQ?

  • Simple - Just one API key, no cloud credentials
  • Secure - Cryptographic verification for every action
  • Auditable - Complete execution trail
  • Fast - Get started in 5 minutes

Installation

pip install armoriq-sdk

CLI commands are also available after install:

armoriq --help

Quick Start

1. Get Your API Key

Visit platform.armoriq.ai to generate your API key.

2. Initialize the Client

from armoriq_sdk import ArmorIQClient

client = ArmorIQClient(
    api_key="ak_your_key_here",
    user_id="your-user-id",
    agent_id="your-agent-id"
)

Or load SDK settings from armoriq.yaml generated by the CLI:

from armoriq_sdk import ArmorIQClient

client = ArmorIQClient.from_config("armoriq.yaml")

3. Capture Your Plan

plan = {
    "goal": "Get weather forecast",
    "steps": [
        {
            "action": "get_weather",
            "tool": "weather_api",
            "inputs": {"city": "Boston"}
        }
    ]
}

plan_capture = client.capture_plan(
    llm="gpt-4",
    prompt="What's the weather in Boston?",
    plan=plan
)

4. Get Intent Token

token = client.get_intent_token(plan_capture)

5. Invoke Actions

result = client.invoke(
    mcp_name="weather-mcp",
    action="get_weather",
    intent_token=token,
    inputs={"city": "Boston"}
)

print(result)

Documentation

For complete documentation, visit docs.armoriq.ai


Links


License

MIT License - see LICENSE file for details.

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

armoriq_sdk_dev-0.3.5.tar.gz (92.4 kB view details)

Uploaded Source

Built Distribution

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

armoriq_sdk_dev-0.3.5-py3-none-any.whl (84.7 kB view details)

Uploaded Python 3

File details

Details for the file armoriq_sdk_dev-0.3.5.tar.gz.

File metadata

  • Download URL: armoriq_sdk_dev-0.3.5.tar.gz
  • Upload date:
  • Size: 92.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for armoriq_sdk_dev-0.3.5.tar.gz
Algorithm Hash digest
SHA256 22530ed36813d9077326045b45de9d77b817000083f2c0a4ff50ec7359905e0a
MD5 39bfea5fee9436e374dde68553be6e26
BLAKE2b-256 8cc3afad555e2a6f2e1f27cfca69bae9b5ac6beb16f02fa43d2b8c6215e807a0

See more details on using hashes here.

File details

Details for the file armoriq_sdk_dev-0.3.5-py3-none-any.whl.

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e9b3add540b10ee965bcaafb479829d179477a6bdbc7fe4a53045515135b6c78
MD5 378d41c6b3c025d2aa8f48fea2eb72f0
BLAKE2b-256 eb19da523217b13404a244610549c76122d360139ab1075653733668c9bd1d87

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