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

Uploaded Python 3

File details

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

File metadata

  • Download URL: armoriq_sdk_dev-0.6.5.tar.gz
  • Upload date:
  • Size: 125.6 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.6.5.tar.gz
Algorithm Hash digest
SHA256 3e9777555f59f72ec51938f85352ff912f026619971ddc9078011032ef160e2a
MD5 e58b4c8ae377d759c91403ba3701a8a5
BLAKE2b-256 ce8bcdfaf9feaad4a23e32ded08147f86791ea54c78722a5b1561569dfc0d037

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for armoriq_sdk_dev-0.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d0737a62ed35494abfab7ca86ae97bbcb94d69bc2a2716842391ad4f83b38191
MD5 8d1aed19b99d18f2ca6426eba234d667
BLAKE2b-256 b1f196a115c1db1c303203f1f9501cf791db0e0d36e8db6ddde10abeeb083147

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