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-0.3.7.tar.gz (92.6 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-0.3.7-py3-none-any.whl (84.8 kB view details)

Uploaded Python 3

File details

Details for the file armoriq_sdk-0.3.7.tar.gz.

File metadata

  • Download URL: armoriq_sdk-0.3.7.tar.gz
  • Upload date:
  • Size: 92.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for armoriq_sdk-0.3.7.tar.gz
Algorithm Hash digest
SHA256 2544b151fab3e726022ba608e5c40d17ad1be815b150d334e754259d9f2346a9
MD5 5d249d453de374200bb7944c80961e81
BLAKE2b-256 5c7ef3161eff5ac661ffbd948f754fdec648a3e4d573d554735d8ccef7dbb366

See more details on using hashes here.

File details

Details for the file armoriq_sdk-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: armoriq_sdk-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 84.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for armoriq_sdk-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 0c90c660dfe248ad6a89df8ee1a8a836f00aa76b3123478e8792001e39b25871
MD5 73a4d37db5567f93e72970f406c3b06a
BLAKE2b-256 cf8a94681647ea0ba3a07d4fbceb4e061e86722e5c6ce896358c2cd9df9dbb50

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