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

Uploaded Python 3

File details

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

File metadata

  • Download URL: armoriq_sdk-0.3.6.tar.gz
  • Upload date:
  • Size: 92.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-0.3.6.tar.gz
Algorithm Hash digest
SHA256 d59a97bb56fe701d4cc64680cdfd530b10e6f6f7e9e139cc8105b1a84c249466
MD5 9b6960d75b46802f4bfbf7a59213d9f5
BLAKE2b-256 49b10c2b1b88172dda2e57c8a086430c9b31f1e44a7d7bc0f59d09fc83f13ccd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: armoriq_sdk-0.3.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 20311cb65036c24ade1275c613fb64c85a93e9615d7fc99b18db1b620ba9c9f1
MD5 ed85d3732b2e9f44eb7b86a842f56a59
BLAKE2b-256 4da50c851634dcec3498aadfd60efca904899f22d6d5b771daa0bc5a652d6899

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