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.4.tar.gz (90.0 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.4-py3-none-any.whl (82.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for armoriq_sdk_dev-0.3.4.tar.gz
Algorithm Hash digest
SHA256 c51a1b551fd7959c2fda8d2054b380e7d269e74fc953e7b585adf4c9f7ca2e8e
MD5 98c7c63f4c2b021e4e03b2e148c84c15
BLAKE2b-256 e46edaec6d75ae35e5d8b1ea2db90d06e266f91059a6061b541fb1a6ccae01c7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4542f1a30382c0d16da812d5b1937634092c6f7580b0663437953acb632764ef
MD5 2029cd3b8619848767788ac687282f6d
BLAKE2b-256 abcb5f683f062fdee04cc9b8da359aa70adde96f98990368e0080bfa52a4c287

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