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.4.3.tar.gz (99.0 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.4.3-py3-none-any.whl (93.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for armoriq_sdk_dev-0.4.3.tar.gz
Algorithm Hash digest
SHA256 68c6d6a87f110000e2ad5eaf170c2089260e7d0beda7d8eb00ed506754245bdb
MD5 70ad987c9b992bc11133517c63e8c364
BLAKE2b-256 e51cf949051c5772010e1a2e9a65dff4909bda0e68a284859515ad1aac5b0862

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 eae10058517d1128ccf7e203df18feb1947f0e910ea539627df28f8f6428a68a
MD5 05d18f32963f4c600de01e0030a23742
BLAKE2b-256 3ca0582cc6928500548ce7741f7d15a847666c23c0682dcbae6d454c27b164f4

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