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.1.tar.gz (87.1 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.1-py3-none-any.whl (79.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for armoriq_sdk_dev-0.3.1.tar.gz
Algorithm Hash digest
SHA256 3588eae32d3b6bccf141dc1b60141a368bc0603dda65c00887512a9d0e2f051c
MD5 cff5d3219ce5cc33379563395985e6e8
BLAKE2b-256 e720d9c0e14a40f37a0f9d2ec0524fe436964c6d0459d9070df1ddf4df144f02

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bf530c1fe78d98b8538edd11c34157aa724d45994cf61e87b45b47c54229d3c5
MD5 ee8938b9eac3da0f9638415b8063c972
BLAKE2b-256 5aa83205b08c219ba3fe8d04696f0ee9452d251de1bad21e44073222b773ae09

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