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.6.4.tar.gz (125.5 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.6.4-py3-none-any.whl (95.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for armoriq_sdk_dev-0.6.4.tar.gz
Algorithm Hash digest
SHA256 c937ca8264cfa8da657a690f8b5cf086308ef376d8258610030cc894f5941466
MD5 ed591449cc94469a8b58b9a035b9c2b0
BLAKE2b-256 86b66c84cadd81598c0185dc8432274add5e51d79ec188f1601f054527c31a99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 69f5646dc3fa1fee189b8543caddbb2ed271f1a57a5cd73c9c027dd4371ab948
MD5 509a15b78ec84558542a20de3a163c80
BLAKE2b-256 12f3e88329003be6d34aaec9cd2bacde84558e3b611fbcac36c1ef2b69089e3d

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