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.2.tar.gz (87.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_dev-0.3.2-py3-none-any.whl (79.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for armoriq_sdk_dev-0.3.2.tar.gz
Algorithm Hash digest
SHA256 fd7a6874640ada02dfc261a1b4575770394e29321f3d908afe1536091cf8b340
MD5 ee728c94dae359377f485df77f551106
BLAKE2b-256 1152d9e4ba61e9e046313befc443b3aedab8b6ba2f76262b6db3e271cd618204

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3501f7e336d0b62b8ec6332ac80c1e0a96952ae1b54861e787094dcaf6bfced6
MD5 457094b266da597018642b3be3dffcd7
BLAKE2b-256 806ea1c7e72088a8a756712095f965b82ec83326f337aaa472570d3a2685c4de

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