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

Uploaded Python 3

File details

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

File metadata

  • Download URL: armoriq_sdk_dev-0.3.6.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_dev-0.3.6.tar.gz
Algorithm Hash digest
SHA256 c3160ec21b3b1f0ad418030e21df2cede7fcfe3c2b719c90cb0e23e6f5c537c9
MD5 510396590437d125546c8f3b14c28c3c
BLAKE2b-256 9300877a69ea5ccd2ade7572adbdc58cd72a436def9e2c7a2a3a60e53de97293

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ec4f06406d5a6b9a0942759599e40f7bcb4e1c23a7fe99cf4d1905819af1f4f5
MD5 5b71b58fa5e0653b3582abca031ccd09
BLAKE2b-256 fbc889ca4824dead627f3e7f288212e2acb87d97959fb8e293536afe10847658

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