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

Uploaded Python 3

File details

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

File metadata

  • Download URL: armoriq_sdk_dev-0.6.6.tar.gz
  • Upload date:
  • Size: 130.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.3

File hashes

Hashes for armoriq_sdk_dev-0.6.6.tar.gz
Algorithm Hash digest
SHA256 569efaf77a7bdb30723ad7537797e4cc596e8ca8fd3c6a368febd1a1f2ca92ba
MD5 2980b0e0a482f22024a8a99ddf4cb67d
BLAKE2b-256 358c62c2b87297246321086e8608d77dc5baf84b511ad286d40bf828c8033686

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0f79cf61f7758b1b73e24df4c9d8944f04e54e01839a613332dde2c4ad9c5281
MD5 6060baf1f7e1024b7339997c1c0fcbda
BLAKE2b-256 55cd41da0ba75b079f368d029ee9d3375fc43cdbb0934a5b61829e32870d304f

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