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

Uploaded Python 3

File details

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

File metadata

  • Download URL: armoriq_sdk_dev-0.6.0.tar.gz
  • Upload date:
  • Size: 103.5 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.6.0.tar.gz
Algorithm Hash digest
SHA256 33c34ac6cc70b28b7759c76d5d928e4936f379d13e9826019bbb7407e06ed920
MD5 193c7663a344751ea4b84c97a4f0cd9c
BLAKE2b-256 26cda63a93277961315cfa9597572b71ea9521ffc27af999d63d6afaf8d37f2d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45f7d2bb54969b656c28d17707af8a7019498a110d7d5e1f76fbc6c9f6151eb1
MD5 b2340bd516a40289bca8c0d3ea566056
BLAKE2b-256 99c01b2cf3dd8696252c18a29cd5edb43cc9235ca185da191f8793a2e53a5908

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