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.3.tar.gz (109.8 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.3-py3-none-any.whl (106.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: armoriq_sdk_dev-0.6.3.tar.gz
  • Upload date:
  • Size: 109.8 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.3.tar.gz
Algorithm Hash digest
SHA256 db8782aaf1095c5e3cc124d26b851b57a033cfd3ff1551701a609a7761118c7f
MD5 0fa372adcb5f42beb8c369882f047ff9
BLAKE2b-256 40dbec6e3588d1fa96bd4ec8152543e77404cb4b19a2bfbc5e3d27b0d5df96c0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4e5d5b06cdaaa1557d4103111ebab4c4b5c9a69bb4c902536d6196359bf9bf02
MD5 e5f254a295769d22f27257cbc99feda8
BLAKE2b-256 5293ff34b915c109e73499941c496381da28ae2bc1369e18ebdaae5d1ecef82a

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