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.5.3.tar.gz (101.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.5.3-py3-none-any.whl (95.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for armoriq_sdk_dev-0.5.3.tar.gz
Algorithm Hash digest
SHA256 5bc2928933dcef80b67587d1614be019facdc5ec142b41c450fad50ee81619c6
MD5 d1bdc22d580ff9d8a5a85e8b7656a051
BLAKE2b-256 c208c589a67f846f1568fc0b2800c256c40c46eb46e31856d0f26de304f7ca8e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 75703d5fbfbea1361ea623ca69e84a64fa0695c8c7550dec4d4f148d3412cbad
MD5 cf4cf7390095ec6b84418ca2b335e932
BLAKE2b-256 bf9c64fa71cb530796321359174192a7c195c3735880a1fcfbb407a076972c51

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