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

Uploaded Python 3

File details

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

File metadata

  • Download URL: armoriq_sdk_dev-0.3.7.tar.gz
  • Upload date:
  • Size: 92.6 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.7.tar.gz
Algorithm Hash digest
SHA256 a54c01a3ccd0ebee5690200db2c390d0b3b51287d939b4dd0a1809d1cb762ab9
MD5 a45c53287de4888dc032a70a510bfe8a
BLAKE2b-256 bf96d17c098c46493b0a9ccc6b3c743d2495d6c65691d6664b111feef1da50d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 0adc1a561ccbc7af4e4f6ede8542688e3736fe03464fd454b099c7979567c3fc
MD5 3197c15d575434f98e4f8106731f3869
BLAKE2b-256 1ceabb317b2f6e8703cad8afdf11c7dba542088f1b8b215cb9f8d0dfffb328a6

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