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

Uploaded Python 3

File details

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

File metadata

  • Download URL: armoriq_sdk-0.3.2.tar.gz
  • Upload date:
  • Size: 88.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for armoriq_sdk-0.3.2.tar.gz
Algorithm Hash digest
SHA256 3c0a3c0c2614d12603822dd5d46ea0299f96214f64f55ab19a9a2fb440c19b2d
MD5 39dda7501c7f26ac4fcfc2e8e308405c
BLAKE2b-256 dd767dc8fdf87540066aa33e9b298e7484a511f5d815fc7c4e861bfd7753fbdf

See more details on using hashes here.

Provenance

The following attestation bundles were made for armoriq_sdk-0.3.2.tar.gz:

Publisher: publish.yml on armoriq/armoriq-sdk-customer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: armoriq_sdk-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 81.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for armoriq_sdk-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2aa05e4e026ed1285cb938e153b5b4ff293d5ca8b6ceb015eaaef754ebb4d3f9
MD5 f8080ecb1519a615460b4b34852e03d3
BLAKE2b-256 a3f1fb57d1cf19d24a6ae56842c4d8e4034c67d7553c4b138a8f9dd184431985

See more details on using hashes here.

Provenance

The following attestation bundles were made for armoriq_sdk-0.3.2-py3-none-any.whl:

Publisher: publish.yml on armoriq/armoriq-sdk-customer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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