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-0.6.5.tar.gz (125.5 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-0.6.5-py3-none-any.whl (95.5 kB view details)

Uploaded Python 3

File details

Details for the file armoriq_sdk-0.6.5.tar.gz.

File metadata

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

File hashes

Hashes for armoriq_sdk-0.6.5.tar.gz
Algorithm Hash digest
SHA256 4047e6a85afd2994df204d165e9e487101735399919a3a4fe517e5ef5dbdc166
MD5 b69739f17e011c6d6718dfd662f32a14
BLAKE2b-256 8f1a852757e2b727a0f4cbfd01c4b64b9ab0bd37703b13615e5f0ec164b656dc

See more details on using hashes here.

File details

Details for the file armoriq_sdk-0.6.5-py3-none-any.whl.

File metadata

  • Download URL: armoriq_sdk-0.6.5-py3-none-any.whl
  • Upload date:
  • Size: 95.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for armoriq_sdk-0.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 38fd04e999f920846ce6e5fde194ec0b0fecf1bbe2e5c1b8835307bd4e1aba33
MD5 fa3d7d29f5140667eb5adf681f38fe78
BLAKE2b-256 79ea7fe332f7aa41e98ee70542efb586b28a4ac5f163a5489f9aa8c4e03bcd4b

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